Distributed Monitoring with Master, Satellites and Agents¶

This chapter will guide you through the setup of a distributed monitoring environment, including high-availability clustering and setup details for Icinga masters, satellites and agents.

Roles: Master, Satellites and Agents¶

Icinga 2 nodes can be given names for easier understanding:

• Amasternode which is on top of the hierarchy.
• Asatellitenode which is a child of asatelliteormasternode.
• Anagentnode which is connected tomasterand/orsatellitenodes.

Rephrasing this picture into more details:

• Amasternode has no parent node.
  • Amasternode is where you usually install Icinga Web 2.
  • Amasternode can combine executed checks from child nodes into backends and notifications.
• Asatellitenode has a parent and a child node.
  • Asatellitenode may execute checks on its own or delegate check execution to child nodes.
  • Asatellitenode can receive configuration for hosts/services, etc. from the parent node.
  • Asatellitenode continues to run even if the master node is temporarily unavailable.
• Anagentnode only has a parent node.
  • Anagentnode will either run its own configured checks or receive command execution events from the parent node.

A client can be a secondary master, a satellite or an agent. It typically requests something from the primary master or parent node.

The following sections will refer to these roles and explain the differences and the possibilities this kind of setup offers.

Note

Previous versions of this documentation used the termIcinga client. This has been refined intoIcinga agentand is visible in the docs, backends and web interfaces.

Tip: If you just want to install a single master node that monitors several hosts (i.e. Icinga agents), continue reading – we’ll start with simple examples. In case you are planning a huge cluster setup with multiple levels and lots of satellites and agents, read on – we’ll deal with these cases later on.

The installation on each system is the same: Follow theinstallation instructionsfor the Icinga 2 package and the required check plugins.

The required configuration steps are mostly happening on the command line. You can alsoautomate the setup.

The first thing you need learn about a distributed setup is the hierarchy of the single components.

Zones¶

The Icinga 2 hierarchy consists of so-calledzoneobjects. Zones depend on a parent-child relationship in order to trust each other.

Have a look at this example for thesatellitezones which have themasterzone as a parent zone:

object Zone "master" { //... } object Zone "satellite region 1" { parent = "master" //... } object Zone "satellite region 2" { parent = "master" //... }

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 trust hierarchy allows for example themasterzone to send configuration files to thesatellitezone. Read more about this in thesecurity section.

agentnodes also have their own unique zone. By convention you must use the FQDN for the zone name.

Endpoints¶

Nodes which are a member of a zone are so-calledEndpointobjects.

Here is an example configuration for two endpoints in different zones:

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" }

All endpoints in the same zone work as high-availability setup. For example, if you have two nodes in themasterzone, they will load-balance the check execution.

Endpoint objects are important for specifying the connection information, e.g. if the master should actively try to connect to an agent.

The zone membership is defined inside theZoneobject definition using theendpointsattribute with an array ofEndpointnames.

Note

There is a knownproblemwith >2 endpoints in a zone and a message routing loop. The config validation will log a warning to let you know about this too.

If you want to check the availability (e.g. ping checks) of the node you still need aHostobject.

ApiListener¶

In case you are using the CLI commands later, you don’t have to write this configuration from scratch in a text editor. TheApiListener对象用于加载TLS证书和specify restrictions, e.g. for accepting configuration commands.

It is also used for theIcinga 2 REST APIwhich shares the same host and port with the Icinga 2 Cluster protocol.

The object configuration is stored in the/etc/icinga2/features-enabled/api.conffile. Depending on the configuration mode the attributesaccept_commandsandaccept_configcan be configured here.

In order to use theapifeature you need to enable it and restart Icinga 2.

icinga2featureenableapi

Conventions¶

By convention all nodes should be configured using their FQDN.

Furthermore, you must ensure that the following names are exactly the same in all configuration files:

• Host certificate common name (CN).
• Endpoint configuration object for the host.
• NodeName constant for the local host.

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.

Security¶

While there are certain mechanisms to ensure a secure communication between all nodes (firewalls, policies, software hardening, etc.), Icinga 2 also provides additional security:

• TLS v1.2+ is required.
• TLS cipher lists are hardenedby default.
• TLS certificates are mandatory for communication between nodes. The CLI command wizards help you create these certificates.
• Child zones only receive updates (check results, commands, etc.) for their configured objects.
• Child zones are not allowed to push configuration updates to parent zones.
• Zones cannot interfere with other zones and influence each other. Each checkable host or service object is assigned toone zoneonly.
• All nodes in a zone trust each other.
• Config syncandremote command endpoint executionis disabled by default.

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.

在分配区域建立信任关系d environment. If you do not specify a zone for an agent/satellite and specify the parent zone, its zone members e.g. the master instance won’t trust the agent/satellite.

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 agent/satellite trusts the master and accepts configuration and commands if enabled in the api feature. If the agent/satellite would send configuration to the parent zone, the parent nodes will deny it. The parent zone is the configuration entity, and does not trust agents/satellites in this matter. An agent/satellite could attempt to modify a different agent/satellite for example, or inject a check command with malicious code.

While it may sound complicated for agent/satellite setups, it removes the problem with different roles and configurations for a master and child nodes. 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.

Versions and Upgrade¶

It generally is advised to use the newest releases with the same version on all instances. Prior to upgrading, make sure to plan a maintenance window.

The Icinga project aims to allow the following compatibility:

master (2.11) >= satellite (2.10) >= agent (2.9)

Older agent versions may work, but there’s no guarantee. Always keep in mind that older versions are out of support and can contain bugs.

In terms of an upgrade, ensure that the master is upgraded first, then involved satellites, and last the Icinga agents. If you are on v2.10 currently, first upgrade the master instance(s) to 2.11, and then proceed with the satellites. Things are getting easier with any sort of automation tool (Puppet, Ansible, etc.).

Releases and new features may require you to upgrade master/satellite instances at once, this is highlighted in theupgrading docsif needed. One example is the CA Proxy and on-demand signing feature available since v2.8 where all involved instances need this version to function properly.

Master Setup¶

This section explains how to install a central single master node using thenode wizardcommand. If you prefer to do an automated installation, please refer to theautomated setupsection.

Follow theinstallation instructionsfor the Icinga 2 package and the required check plugins if you haven’t done so already.

Note: Windows is not supported for a master node setup.

The next step is to run thenode wizardCLI command. Prior to that ensure to collect the required information:

The setup wizard will ensure that the following steps are taken:

• Enable theapifeature.
• Generate a new certificate authority (CA) in/var/lib/icinga2/caif it doesn’t exist.
• Create a certificate for this node signed by the CA key.
• Update thezones.conffile with the new zone hierarchy.
• Update theApiListenerandconstantsconfiguration.
• Update theicinga2.confto disable theconf.dinclusion, and add theapi-users.conffile inclusion.

Here is an example of a master setup for theicinga2-master1.localdomainnode on CentOS 7:

(root@icinga2-master1.localdomain /) # icinga2节点wizard Welcome to the Icinga 2 Setup Wizard! We will guide you through all required configuration details. Please specify if this is a satellite/agent 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... Checking for existing certificates for common name 'icinga2-master1.localdomain'... Certificates not yet generated. Running 'api setup' now. Generating master configuration for Icinga 2. Enabling feature api. Make sure to restart Icinga 2 for these changes to take effect. Master zone name [master]: Default global zones: global-templates director-global Do you want to specify additional global zones? [y/N]: N Please specify the API bind host/port (optional): Bind Host []: Bind Port []: 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... 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/cadirectory. Keep this path secure and include it in your backups.

In case you lose the CA private key you have to generate a new CA for signing new agent/satellite certificate requests. You then have to also re-create new signed certificates for all existing nodes.

Once the master setup is complete, you can also use this node as primaryCSR auto-signingmaster. The following section will explain how to use the CLI commands in order to fetch their signed certificate from this master node.

Signing Certificates on the Master¶

All certificates must be signed by the same certificate authority (CA). This ensures that all nodes trust each other in a distributed monitoring environment.

This CA is generated during themaster setupand should be the same on all master instances.

You can avoid signing and deploying certificatesmanuallyby using built-in methods for auto-signing certificate signing requests (CSR):

• CSR Auto-Signingwhich uses a client (an agent or a satellite) ticket generated on the master as trust identifier.
• On-Demand CSR Signingwhich allows to sign pending certificate requests on the master.

Both methods are described in detail below.

Note

On-Demand CSR Signingis available in Icinga 2 v2.8+.

CSR Auto-Signing¶

A client can be a secondary master, a satellite or an agent. It sends a certificate signing request (CSR) and 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 added the possibility to forward signing requests on a satellite to the master node. This is calledCA Proxyin blog posts and design drafts. This functionality helps with the setup ofthree level clustersand more.

Advantages:

• Nodes (secondary master, satellites, agents) 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.

Disadvantages:

• Tickets need to be generated on the master and copied to client setup wizards.
• No central signing management.

CSR Auto-Signing: Preparation¶

Prior to using this mode, ensure that the following steps are taken on the signing master:

• Themaster setupwas run successfully. This includes:
  • Generated a CA key pair
  • Generated a private ticket salt stored in theTicketSaltconstant, set asticket_saltattribute inside theapifeature.
• Restart of the master instance.

CSR Auto-Signing: On the master¶

Setup wizards for agent/satellite nodes will ask you for this specific client ticket.

There are two possible ways to retrieve the ticket:

• CLI commandexecuted on the master node.
• REST APIrequest against the master node.

Required information:

The following example shows how to generate a ticket on the master nodeicinga2-master1.localdomainfor the agenticinga2-agent1.localdomain:

[root@icinga2-master1.localdomain /]# icinga2 pki ticket --cn icinga2-agent1.localdomain

Querying theIcinga 2 APIon the master requires anApiUserobject with at least theactions/generate-ticketpermission.

(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 Retrieve the ticket on the master node `icinga2-master1.localdomain` with `curl`, for example: [root@icinga2-master1.localdomain /]# curl -k -s -u client-pki-ticket:bea11beb7b810ea9ce6ea -H 'Accept: application/json' \ -X POST 'https://localhost:5665/v1/actions/generate-ticket' -d '{ "cn": "icinga2-agent1.localdomain" }'

Store that ticket number for theagent/satellite setupbelow.

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 theautomated setup steps.

On-Demand CSR Signing¶

The client can be a secondary master, satellite or agent. It sends a certificate signing request to specified parent node without any ticket. The admin on the primary master is responsible for reviewing and signing the requests with the private CA key.

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.

On-Demand CSR Signing: Preparation¶

Prior to using this mode, ensure that the following steps are taken on the signing master:

• Themaster setupwas run successfully. This includes:
  • Generated a CA key pair
• Restart of the master instance.

On-Demand CSR Signing: On the master¶

You can list pending certificate signing requests with theca listCLI command.

[root@icinga2-master1.localdomain /]# icinga2 ca list Fingerprint | Timestamp | Signed | Subject -----------------------------------------------------------------|---------------------|--------|-------- 71700c28445109416dd7102038962ac3fd421fbb349a6e7303b6033ec1772850 | 2017/09/06 17:20:02 | | CN = icinga2-agent2.localdomain

In order to show all requests, use the--allparameter.

[root@icinga2-master1.localdomain /]# icinga2 ca list --all Fingerprint | Timestamp | Signed | Subject -----------------------------------------------------------------|---------------------|--------|-------- 403da5b228df384f07f980f45ba50202529cded7c8182abf96740660caa09727 | 2017/09/06 17:02:40 | * | CN = icinga2-agent1.localdomain 71700c28445109416dd7102038962ac3fd421fbb349a6e7303b6033ec1772850 | 2017/09/06 17:20:02 | | CN = icinga2-agent2.localdomain

Tip: Add--jsonCLI命令来检索JSON的细节format.

If you want to sign a specific request, you need to use theca signCLI command and pass its fingerprint as argument.

[root@icinga2-master1.localdomain /]# icinga2 ca sign 71700c28445109416dd7102038962ac3fd421fbb349a6e7303b6033ec1772850 information/cli: Signed certificate for 'CN = icinga2-agent2.localdomain'.

Note

ca listcannot be used as historical inventory. Certificate signing requests older than 1 week are automatically deleted.

You can also remove an undesired CSR using theca removecommand using the syntax as theca signcommand.

[root@pym ~]# icinga2 ca remove 5c31ca0e2269c10363a97e40e3f2b2cd56493f9194d5b1852541b835970da46e information/cli: Certificate 5c31ca0e2269c10363a97e40e3f2b2cd56493f9194d5b1852541b835970da46e removed.

Agent/Satellite Setup¶

This section describes the setup of an agent or satellite connected to an existing master node setup. If you haven’t done so already, pleaserun the master setup.

Icinga 2 on the master node must be running and accepting connections on port5665.

Agent/Satellite Setup on Linux¶

Please ensure that you’ve run all the steps mentioned in theagent/satellite section.

Follow theinstallation instructionsfor the Icinga 2 package and the required check plugins if you haven’t done so already.

The next step is to run thenode wizardCLI command.

In this example we’re generating a ticket on the master nodeicinga2-master1.localdomainfor the agenticinga2-agent1.localdomain:

[root@icinga2-master1.localdomain /]# icinga2 pki ticket --cn icinga2-agent1.localdomain 4f75d2ecd253575fe9180938ebff7cbca262f96e

Note: You don’t need this step if you have chosen to useOn-Demand CSR Signing.

Start the wizard on the agenticinga2-agent1.localdomain:

[root@icinga2-agent1.localdomain /]# icinga2 node wizard Welcome to the Icinga 2 Setup Wizard! We will guide you through all required configuration details.

PressEnteror addyto start a satellite or agent setup.

Please specify if this is an agent/satellite setup ('n' installs a master setup) [Y/n]:

PressEnterto use the proposed name in brackets, or add a specific common name (CN). By convention this should be the FQDN.

Starting the Agent/Satellite setup routine... Please specify the common name (CN) [icinga2-agent1.localdomain]: icinga2-agent1.localdomain

Specify the direct parent for this node. This could be your primary mastericinga2-master1.localdomainor 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

PressEnteror chooseyto 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, choosen. The setup wizard will provide instructions for this scenario – signing questions are disabled then.

Add the connection details foricinga2-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. PressEnteror choosenif 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.

You can verify the fingerprint by running the following command on the node to connect to:

opensslx509-noout-fingerprint-sha256-in\"/var/lib/icinga2/certs/$(hostname--fqdn).crt"

Note: The certificate is not fetched if you have chosen not to connect to the parent node.

Proceed with adding the optional client ticket forCSR auto-signing:

Please specify the request ticket generated on your Icinga 2 master (optional). (Hint: # icinga2 pki ticket --cn 'icinga2-agent1.localdomain'): 4f75d2ecd253575fe9180938ebff7cbca262f96e

In case you’ve chosen to useOn-Demand CSR Signingyou 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 forconfig sync mode) and commands (required forcommand endpoint mode).

Accept config from parent node? [y/N]: y Accept commands from parent node? [y/N]: y

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-agent1.localdomain]:

Set the parent zone name to something else thanmasterif this agents connects to a satellite instance instead of the master.

Parent zone name [master]:

You can add more global zones in addition toglobal-templatesanddirector-globalif necessary. PressEnteror choosen, if you don’t want to add any additional.

Reconfiguring Icinga... Default global zones: global-templates director-global Do you want to specify additional global zones? [y/N]: N

Last but not least the wizard asks you whether you want to disable the inclusion of the local configuration directory inconf.d, or not. Defaults to disabled, as agents 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...

The wizard proceeds and you are good to go.

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 tomanually sign the CSR on the master node.

Restart Icinga 2 as requested.

[root@icinga2-agent1.localdomain /]# systemctl restart icinga2

Here is an overview of all parameters in detail:

The setup wizard will ensure that the following steps are taken:

• Enable theapifeature.
• Create a certificate signing request (CSR) for the local node.
• Request a signed certificate (optional with the provided ticket number) on the master node.
• Allow to verify the parent node’s certificate.
• Store the signed agent/satellite certificate and ca.crt in/var/lib/icinga2/certs.
• Update thezones.conffile with the new zone hierarchy.
• Update/etc/icinga2/features-enabled/api.conf(accept_config,accept_commands) andconstants.conf.
• Update/etc/icinga2/icinga2.confand comment outinclude_recursive "conf.d".

You can verify that the certificate files are stored in the/var/lib/icinga2/certsdirectory.

Note

If the agent is not directly connected to the certificate signing master, signing requests and responses might need some minutes to fully update the agent certificates.

If you have chosen to useOn-Demand CSR Signingcertificates need to be signed on the master first. Ticket-less setups require at least Icinga 2 v2.8+ on all involved instances.

Now that you’ve successfully installed a Linux/Unix agent/satellite instance, please proceed to theconfiguration modes.

Agent Setup on Windows¶

The supported Windows agent versions are listedhere.

Requirements:

• Microsoft .NET Framework 4.6or higher. This is the default on Windows Server 2016 or later.
• Universal C Runtime for Windowsfor Windows Server 2012 and older.

Agent Setup on Windows: Installer¶

Download the MSI-Installer package fromhttps://packages.www.directade.com/windows/. The preferred flavor isx86_64for modern Windows systems.

The Windows package provides nativemonitoring plugin binariesto get you started more easily. The installer package also includes theNSClient++package to allow using its built-in plugins. You can find more details inthis chapter.

Note

Please note that Icinga 2 was designed to run as light-weight agent on Windows. There is no support for satellite instances.

运行the MSI-Installer package and follow the instructions shown in the screenshots.

The graphical installer offers to run theIcinga Agent setup wizardafter the installation. Select the check box to proceed.

Tip

You can also run the Icinga agent setup wizard from the Start menu later.

Agent Setup on Windows: Configuration Wizard¶

On a fresh installation the setup wizard guides you through the initial configuration. It also provides a mechanism to send a certificate request to theCSR signing master.

The following configuration details are required:

Fill in the required information and clickAddto add a new master connection.

Add the following details:

When needed you can add an additional global zone (the zonesglobal-templatesanddirector-globalare added by default):

Optionally enable the following settings:

Verify the certificate from the master/satellite instance where this node should connect to.

Bundled NSClient++ Setup¶

If you have chosen to install/update the NSClient++ package, the Icinga 2 setup wizard asks you to do so.

Choose theGenericsetup.

Choose theCustomsetup type.

NSClient++ does not install a sample configuration by default. Change this as shown in the screenshot.

Generate a secure password and enable the web server module.Note: The webserver module is available starting with NSClient++ 0.5.0. Icinga 2 v2.6+ is required which includes this version.

Finish the installation.

Open a web browser and navigate tohttps://localhost:8443. Enter the password you’ve configured during the setup. In case you lost it, look into theC:\Program Files\NSClient++\nsclient.iniconfiguration file.

The NSClient++ REST API can be used to query metrics.check_nscp_apiuses this transport method.

Finish Windows Agent Setup¶

Finish the Windows setup wizard.

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.

Icinga 2 is automatically started as a Windows service.

The Icinga 2 configuration is stored inside theC:\ProgramData\icinga2directory. ClickExamine Configin the setup wizard to open a new Explorer window.

The configuration files can be modified with your favorite editor e.g. Notepad++ or vim in Powershell (via chocolatey).

In order to use thetop downagent configuration prepare the following steps.

You don’t need any local configuration on the agent except for CheckCommand definitions which can be synced using the global zone above. Therefore disable the inclusion of theconf.ddirectory in theicinga2.conffile.

Navigate toC:\ProgramData\icinga2\etc\icinga2and open theicinga2.conffile in your preferred editor. Remove or comment (//) the following line:

// Commented out, not required on an agent 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.

Validate the configuration on Windows open an administrative Powershell and run the following command:

C:\> cd C:\Program Files\ICINGA2\sbin C:\Program Files\ICINGA2\sbin> .\icinga2.exe daemon -C

Note: You have to run this command in a shell withadministratorprivileges.

现在你需要重新启动Icinga 2服务。运行services.mscfrom the start menu and restart theicinga2service. Alternatively open an administrative Powershell and run the following commands:

C:\> Restart-Service icinga2 C:\> Get-Service icinga2

Now that you’ve successfully installed a Windows agent, please proceed to thedetailed configuration modes.

Configuration Modes¶

There are different ways to ensure that the Icinga 2 cluster nodes execute checks, send notifications, etc.

The preferred method is to configure monitoring objects on the master and distribute the configuration to satellites and agents.

The following chapters explain this in detail with hands-on manual configuration examples. You should test and implement this once to fully understand how it works.

Once you are familiar with Icinga 2 and distributed monitoring, you can start with additional integrations to manage and deploy your configuration:

• Icinga Directorprovides a web interface to manage configuration and also allows to sync imported resources (CMDB, PuppetDB, etc.)
• Ansible Roles
• Puppet Module
• Chef Cookbook

More details can be foundhere.

Top Down¶

There are two different behaviors with check execution:

• 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.

Again, technically it does not matter whether this is anagentor asatellitewhich is receiving configuration or command execution events.

Top Down Command Endpoint¶

这种模式迫使Icinga 2节点执行通讯ands remotely on a specified endpoint. The host/service object configuration is located on the master/satellite and the agent only needs the CheckCommand object definitions available.

Every endpoint has its own remote check queue. The amount of checks executed simultaneously can be limited on the endpoint with theMaxConcurrentChecksconstant defined inconstants.conf. Icinga 2 may discard check requests, if the remote check queue is full.

Advantages:

• No local checks need to be defined on the child node (agent).
• Light-weight remote check execution (asynchronous events).
• Noreplay logis necessary for the child node.
• Pin checks to specific endpoints (if the child zone consists of 2 endpoints).

Disadvantages:

• If the child node is not connected, no more checks are executed.
• Requires additional configuration attribute specified in host/service objects.
• Requires localCheckCommandobject configuration. Best practice is to use aglobal config zone.

To make sure that all nodes involved will accept configuration and/or commands, you need to configure theZoneandEndpointhierarchy on all nodes.

• icinga2-master1.localdomain是configuration master in this scenario.
• icinga2-agent1.localdomainacts as agent which receives command execution messages via command endpoint from the master. In addition, it receives the global check command configuration from the master.

Include the endpoint and zone configuration onbothnodes in the file/etc/icinga2/zones.conf.

The endpoint configuration could look like this, for example:

[root@icinga2-agent1.localdomain /]# vim /etc/icinga2/zones.conf object Endpoint "icinga2-master1.localdomain" { host = "192.168.56.101" } object Endpoint "icinga2-agent1.localdomain" { host = "192.168.56.111" log_duration = 0 // Disable the replay log for command endpoint agents }

Next, you need to define two zones. There is no naming convention, best practice is to either usemaster,satellite/agent-fqdnor to choose region names for exampleEurope,USAandAsia, though.

Note: Each agent requires its own zone and endpoint configuration. Best practice is to use the agent’s FQDN for all object names.

Themasterzone is a parent of theicinga2-agent1.localdomainzone:

[root@icinga2-agent1.localdomain /]# vim /etc/icinga2/zones.conf object Zone "master" { endpoints = [ "icinga2-master1.localdomain" ] //array with endpoint names } object Zone "icinga2-agent1.localdomain" { endpoints = [ "icinga2-agent1.localdomain" ] parent = "master" //establish zone hierarchy }

You don’t need any local configuration on the agent except for CheckCommand definitions which can be synced using the global zone above. Therefore disable the inclusion of theconf.ddirectory in/etc/icinga2/icinga2.conf.

[root@icinga2-agent1.localdomain /]# vim /etc/icinga2/icinga2.conf // Commented out, not required on an agent as command endpoint //include_recursive "conf.d"

Note

Packages >= 2.9 provide an option in the setup wizard to disable this. Defaults to disabled.

Now it is time to validate the configuration and to restart the Icinga 2 daemon on both nodes.

Example on CentOS 7:

[root@icinga2-agent1.localdomain /]# icinga2 daemon -C [root@icinga2-agent1.localdomain /]# systemctl restart icinga2 [root@icinga2-master1.localdomain /]# icinga2 daemon -C [root@icinga2-master1.localdomain /]# systemctl restart icinga2

Once the agents have successfully connected, you are ready for the next step:execute a remote check on the agent using the command endpoint.

Include the host and service object configuration in themasterzone – this will help adding a secondary master for high-availability later.

[root@icinga2-master1.localdomain /]# mkdir -p /etc/icinga2/zones.d/master

Add the host and service objects you want to monitor. There is no limitation for files and directories – best practice is to sort things by type.

By convention a master/satellite/agent host object should use the same name as the endpoint object. You can also add multiple hosts which execute checks against remote services/agents.

The following example adds theagent_endpointcustom variable to the host and stores its name (FQDN).Versions older than 2.11 used theclient_endpointcustom variable.

This custom variable serves two purposes: 1) Service apply rules can match against it. 2) Apply rules can retrieve its value and assign it to thecommand_endpointattribute.

(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-agent1.localdomain" { check_command = "hostalive" //check is executed on the master address = "192.168.56.111" vars.agent_endpoint = name //follows the convention that host name == endpoint name }

Given that you are monitoring a Linux agent, add a remotediskcheck.

(root@icinga2-master1.localdomain /etc/icinga2/zones.d/master]# vim services.conf apply Service "disk" { check_command = "disk" // Specify the remote agent as command execution endpoint, fetch the host custom variable command_endpoint = host.vars.agent_endpoint // Only assign where a host is marked as agent endpoint assign where host.vars.agent_endpoint }

If you have your own customCheckCommanddefinition, add it to the global zone:

[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" { //... }

Save the changes and validate the configuration on the master node:

[root@icinga2-master1.localdomain /]# icinga2 daemon -C

[root@icinga2-master1.localdomain /]# systemctl restart icinga2

The following steps will happen:

• Icinga 2 validates the configuration onicinga2-master1.localdomainand restarts.
• Theicinga2-master1.localdomainnode schedules and executes the checks.
• Theicinga2-agent1.localdomainnode receives the execute command event with additional command parameters.
• Theicinga2-agent1.localdomainnode maps the command parameters to the local check command, executes the check locally, and sends back the check result message.

As you can see, no interaction from your side is required on the agent itself, and it’s not necessary to reload the Icinga 2 service on the agent.

You have learned the basics about command endpoint checks. Proceed with thescenariossection where you can find detailed information on extending the setup.

Top Down Config Sync¶

This mode syncs the object configuration files within specified zones. It comes in handy if you want to configure everything on the master node 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.

Advantages:

• Sync the configuration files from the parent zone to the child zones.
• No manual restart is required on the child nodes, as syncing, validation, and restarts happen automatically.
• 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.
• Additional zone and endpoint configuration needed.
• Replay log is replicated on reconnect after connection loss. This might increase the data transfer and create an overload on the connection.

Note

This mode only supportsconfiguration text filesfor Icinga. Do not abuse this for syncing binaries, this is not supported and may harm your production environment. The config sync uses checksums to detect changes, binaries may trigger reload loops.

This is a fair warning. If you want to deploy plugin binaries, create packages for dependency management and use infrastructure lifecycle tools such as Foreman, Puppet, Ansible, etc.

To make sure that all involved nodes accept configuration and/or commands, you need to configure theZoneandEndpointhierarchy on all nodes.

• icinga2-master1.localdomain是configuration master in this scenario.
• icinga2-satellite1.localdomainacts as satellite which receives configuration from the master. Checks are scheduled locally.

Include the endpoint and zone configuration onbothnodes in the file/etc/icinga2/zones.conf.

The endpoint configuration could look like this:

[root@icinga2-satellite1.localdomain /]# vim /etc/icinga2/zones.conf object Endpoint "icinga2-master1.localdomain" { host = "192.168.56.101" } object Endpoint "icinga2-satellite1.localdomain" { host = "192.168.56.105" }

Next, you need to define two zones. There is no naming convention, best practice is to either usemaster,satellite/agent-fqdnor to choose region names for exampleEurope,USAandAsia, though.

Themasterzone is a parent of thesatellitezone:

[root@icinga2-agent2.localdomain /]# vim /etc/icinga2/zones.conf object Zone "master" { endpoints = [ "icinga2-master1.localdomain" ] //array with endpoint names } object Zone "satellite" { endpoints = [ "icinga2-satellite1.localdomain" ] parent = "master" //establish zone hierarchy }

Edit theapifeature on the satelliteicinga2-satellite1.localdomainin the/etc/icinga2/features-enabled/api.conffile and setaccept_configtotrue.

[root@icinga2-satellite1.localdomain /]# vim /etc/icinga2/features-enabled/api.conf object ApiListener "api" { //... accept_config = true }

Now it is time to validate the configuration and to restart the Icinga 2 daemon on both nodes.

Example on CentOS 7:

[root@icinga2-satellite1.localdomain /]# icinga2 daemon -C [root@icinga2-satellite1.localdomain /]# systemctl restart icinga2 [root@icinga2-master1.localdomain /]# icinga2 daemon -C [root@icinga2-master1.localdomain /]# systemctl restart icinga2

Tip: Best practice is to use aglobal zonefor common configuration items (check commands, templates, groups, etc.).

Once the satellite(s) have connected successfully, it’s time for the next step:execute a local check on the satellite using the configuration sync.

Navigate to/etc/icinga2/zones.don your master nodeicinga2-master1.localdomainand create a new directory with the same name as your satellite/agent zone name:

[root@icinga2-master1.localdomain /]# mkdir -p /etc/icinga2/zones.d/satellite

Add the host and service objects you want to monitor. There is no limitation for files and directories – best practice is to sort things by type.

By convention a master/satellite/agent host object should use the same name as the endpoint object. You can also add multiple hosts which execute checks against remote services/agents viacommand endpointchecks.

(root@icinga2-master1.localdomain /) # cd /etc/icinga2/zones.d/satellite [root@icinga2-master1.localdomain /etc/icinga2/zones.d/satellite]# vim hosts.conf object Host "icinga2-satellite1.localdomain" { check_command = "hostalive" address = "192.168.56.112" zone = "master" //optional trick: sync the required host object to the satellite, but enforce the "master" zone to execute the check }

Given that you are monitoring a Linux satellite add a localdiskcheck.

(root@icinga2-master1.localdomain /etc/icinga2/zones.d/satellite]# vim services.conf object Service "disk" { host_name = "icinga2-satellite1.localdomain" check_command = "disk" }

Save the changes and validate the configuration on the master node:

[root@icinga2-master1.localdomain /]# icinga2 daemon -C

Restart the Icinga 2 daemon (example for CentOS 7):

[root@icinga2-master1.localdomain /]# systemctl restart icinga2

The following steps will happen:

• Icinga 2 validates the configuration onicinga2-master1.localdomain.
• Icinga 2 copies the configuration into its zone config store in/var/lib/icinga2/api/zones.
• Theicinga2-master1.localdomainnode sends a config update event to all endpoints in the same or direct child zones.
• Theicinga2-satellite1.localdomainnode accepts config and populates the local zone config store with the received config files.
• Theicinga2-satellite1.localdomainnode validates the configuration and automatically restarts.

Again, there is no interaction required on the satellite itself.

You can also use the config sync inside a high-availability zone to ensure that all config objects are synced among zone members.

Note: You can only have one so-called “config master” in a zone which stores the configuration in thezones.ddirectory. Multiple nodes with configuration files in thezones.ddirectory arenot supported.

Now that you’ve learned the basics about the configuration sync, proceed with thescenariossection where you can find detailed information on extending the setup.

If you are eager to start fresh instead you might take a look into theIcinga Director.

Scenarios¶

The following examples should give you an idea on how to build your own distributed monitoring environment. We’ve seen them all in production environments and received feedback from our欧宝app官网网址andpartner supportchannels:

• Single master with agents.
• HA master with agents as command endpoint
• Three level clusterwith config HA masters, satellites receiving config sync, and agents checked using command endpoint.

You can also extend the cluster tree depth to four levels e.g. with 2 satellite levels. Just keep in mind that multiple levels become harder to debug in case of errors.

You can also start with a single master setup, and later add a secondary master endpoint. This requires an extra step with theinitial syncfor cloning the runtime state. This is described in detailhere.

Master with Agents¶

In this scenario, a single master node runs the check scheduler, notifications and IDO database backend and uses thecommand endpoint modeto execute checks on the remote agents.

• icinga2-master1.localdomain是primary master node.
• icinga2-agent1.localdomainandicinga2-agent2.localdomainare two child nodes as agents.

Setup requirements:

• Set upicinga2-master1.localdomainasmaster.
• Set upicinga2-agent1.localdomainandicinga2-agent2.localdomainasagent.

Edit thezones.confconfiguration file on the master:

(root@icinga2-master1.localdomain /) # vim /etc/icinga2/zones.conf object Endpoint "icinga2-master1.localdomain" { // That's us } object Endpoint "icinga2-agent1.localdomain" { host = "192.168.56.111" // The master actively tries to connect to the agent log_duration = 0 // Disable the replay log for command endpoint agents } object Endpoint "icinga2-agent2.localdomain" { host = "192.168.56.112" // The master actively tries to connect to the agent log_duration = 0 // Disable the replay log for command endpoint agents } object Zone "master" { endpoints = [ "icinga2-master1.localdomain" ] } object Zone "icinga2-agent1.localdomain" { endpoints = [ "icinga2-agent1.localdomain" ] parent = "master" } object Zone "icinga2-agent2.localdomain" { endpoints = [ "icinga2-agent2.localdomain" ] parent = "master" } /* sync global commands */ object Zone "global-templates" { global = true } object Zone "director-global" { global = true }

The two agent nodes do not need to know about each other. The only important thing is that they know about the parent zone and their endpoint members (and optionally the global zone).

If you specify thehostattribute in theicinga2-master1.localdomainendpoint object, the agent will actively try to connect to the master node. Since you’ve specified the agent endpoint’s attribute on the master node already, you don’t want the agents to connect to the master.Choose oneconnection direction.

[root@icinga2-agent1.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-agent1.localdomain" { // That's us } object Zone "master" { endpoints = [ "icinga2-master1.localdomain" ] } object Zone "icinga2-agent1.localdomain" { endpoints = [ "icinga2-agent1.localdomain" ] parent = "master" } /* sync global commands */ object Zone "global-templates" { global = true } object Zone "director-global" { global = true }

[root@icinga2-agent2.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-agent2.localdomain" { // That's us } object Zone "master" { endpoints = [ "icinga2-master1.localdomain" ] } object Zone "icinga2-agent2.localdomain" { endpoints = [ "icinga2-agent2.localdomain" ] parent = "master" } /* sync global commands */ object Zone "global-templates" { global = true } object Zone "director-global" { global = true }

现在是时候来定义两个代理主机和一个pply service checks using the command endpoint execution method on them. Note: You can also use the config sync mode here.

Create a new configuration directory on the master node:

[root@icinga2-master1.localdomain /]# mkdir -p /etc/icinga2/zones.d/master

Add the two agent nodes as host objects:

(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-agent1.localdomain" { check_command = "hostalive" address = "192.168.56.111" vars.agent_endpoint = name //follows the convention that host name == endpoint name } object Host "icinga2-agent2.localdomain" { check_command = "hostalive" address = "192.168.56.112" vars.agent_endpoint = name //follows the convention that host name == endpoint name }

Add services using command endpoint checks:

(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" // Execute the check on the remote command endpoint command_endpoint = host.vars.agent_endpoint // Assign the service onto an agent assign where host.vars.agent_endpoint }

Validate the configuration and restart Icinga 2 on the master nodeicinga2-master1.localdomain.

[root@icinga2-master1.localdomain /]# icinga2 daemon -C [root@icinga2-master1.localdomain /]# systemctl restart icinga2

Open Icinga Web 2 and check the two newly created agent hosts with two new services – one executed locally (ping4) and one using command endpoint (disk).

Note

You don’t necessarily need to add the agent endpoint/zone configuration objects into the master’s zones.conf file. Instead, you can put them into/etc/icinga2/zones.d/mastereither inhosts.confshown above, or in a new file calledagents.conf.

Tip:

It’s a good idea to addhealth checksto make sure that your cluster notifies you in case of failure.

In terms of health checks, consider adding the following for this scenario:

• Master node(s) check the connection to the agents
• Optional: Add dependencies for the agent host to prevent unwanted notifications when agents are unreachable

Proceed inthis chapter.

High-Availability Master with Agents¶

This scenario is similar to the one in theprevious section. The only difference is that we will now set up two master nodes in a high-availability setup. These nodes must be configured as zone and endpoints objects.

The setup uses the capabilities of the Icinga 2 cluster. All zone members replicate cluster events between each other. In addition to that, several Icinga 2 features can enableHA functionality.

Best practice is to run the database backend on a dedicated server/cluster and only expose a virtual IP address to Icinga and the IDO feature. By default, only one endpoint will actively write to the backend then. Typical setups for MySQL clusters involve Master-Master-Replication (Master-Slave-Replication in both directions) or Galera, more tips can be found on ourcommunity forums. The IDO object must have the sameinstance_nameon all master nodes.

Note: All nodes in the same zone require that you enable the same features for high-availability (HA).

Overview:

• icinga2-master1.localdomain是config master master node.
• icinga2-master2.localdomain是secondary master master node without config inzones.d.
• icinga2-agent1.localdomainandicinga2-agent2.localdomainare two child nodes as agents.

Setup requirements:

• Set upicinga2-master1.localdomainasmaster.
• Set upicinga2-master2.localdomainassatellite(we will modify the generated configuration).
• Set upicinga2-agent1.localdomainandicinga2-agent2.localdomainasagents(when asked for adding multiple masters, set toyand add the secondary mastericinga2-master2.localdomain).

In case you don’t want to use the CLI commands, you can also manually create and sync the required TLS certificates. We will modify and discuss all the details of the automatically generated configuration here.

Since there are now two nodes in the same zone, we must consider thehigh-availability features.

• 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.
• 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.

One possibility is to use a dedicated MySQL cluster VIP (external application cluster) 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.).

Note

You can also start with a single master shownhereand later add the second master. This requires an extra step with theinitial syncfor cloning the runtime state after done. Once done, proceed here.

In this scenario, we are not adding the agent configuration immediately to thezones.conffile but will establish the hierarchy later.

The first master looks like this:

(root@icinga2-master1.localdomain /) # vim /etc/icinga2/zones.conf object Endpoint "icinga2-master1.localdomain" { // That's us } object Endpoint "icinga2-master2.localdomain" { host = "192.168.56.102" // Actively connect to the secondary master } object Zone "master" { endpoints = [ "icinga2-master1.localdomain", "icinga2-master2.localdomain" ] } /* sync global commands */ object Zone "global-templates" { global = true } object Zone "director-global" { global = true }

The secondary master waits for connection attempts from the first master, and therefore does not try to connect to it again.

[root@icinga2-master2.localdomain /]# vim /etc/icinga2/zones.conf object Endpoint "icinga2-master1.localdomain" { // The first master already connects to us } object Endpoint "icinga2-master2.localdomain" { // That's us } object Zone "master" { endpoints = [ "icinga2-master1.localdomain", "icinga2-master2.localdomain" ] } /* sync global commands */ object Zone "global-templates" { global = true } object Zone "director-global" { global = true }

Restart both masters and ensure the initial connection and TLS handshake works.

The two agent nodes do not need to know about each other. The only important thing is that they know about the parent zone and their endpoint members (and optionally about the global zone).

If you specify thehostattribute in theicinga2-master1.localdomainandicinga2-master2.localdomainendpoint objects, the agent will actively try to connect to the master node. Since we’ve specified the agent endpoint’s attribute on the master node already, we don’t want the agent to connect to the master nodes.Choose oneconnection direction.

[root@icinga2-agent1.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-agent1.localdomain" { // That's us } object Zone "master" { endpoints = [ "icinga2-master1.localdomain", "icinga2-master2.localdomain" ] } object Zone "icinga2-agent1.localdomain" { endpoints = [ "icinga2-agent1.localdomain" ] parent = "master" } /* sync global commands */ object Zone "global-templates" { global = true } object Zone "director-global" { global = true }

[root@icinga2-agent2.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-agent2.localdomain" { //That's us } object Zone "master" { endpoints = [ "icinga2-master1.localdomain", "icinga2-master2.localdomain" ] } object Zone "icinga2-agent2.localdomain" { endpoints = [ "icinga2-agent2.localdomain" ] parent = "master" } /* sync global commands */ object Zone "global-templates" { global = true } object Zone "director-global" { global = true }

现在是时候来定义两个代理主机和一个pply service checks using the command endpoint execution method.

Create a new configuration directory on the master nodeicinga2-master1.localdomain.Note: The secondary master nodeicinga2-master2.localdomainreceives the configuration using theconfig sync mode.

[root@icinga2-master1.localdomain /]# mkdir -p /etc/icinga2/zones.d/master

Add the two agent nodes with their zone/endpoint and host object configuration.

Note

In order to keep things in sync between the two HA masters, keep thezones.conffile as small as possible.

You can create the agent zone and endpoint objects inside the master zone and have them synced to the secondary master. The cluster config sync enforces a reload allowing the secondary master to connect to the agents as well.

Edit thezones.conffile and ensure that the agent zone/endpoint objects arenotspecified in there.

Then navigate into/etc/icinga2/zones.d/masterand create a new fileagents.conf.

(root@icinga2-master1.localdomain /) # cd /etc/icinga2/zones.d/master [root@icinga2-master1.localdomain /etc/icinga2/zones.d/master]# vim agents.conf //----------------------------------------------- // Endpoints object Endpoint "icinga2-agent1.localdomain" { host = "192.168.56.111" // The master actively tries to connect to the agent log_duration = 0 // Disable the replay log for command endpoint agents } object Endpoint "icinga2-agent2.localdomain" { host = "192.168.56.112" // The master actively tries to connect to the agent log_duration = 0 // Disable the replay log for command endpoint agents } //----------------------------------------------- // Zones object Zone "icinga2-agent1.localdomain" { endpoints = [ "icinga2-agent1.localdomain" ] parent = "master" } object Zone "icinga2-agent2.localdomain" { endpoints = [ "icinga2-agent2.localdomain" ] parent = "master" }

Whenever you need to add an agent again, edit the mentioned files.

接下来,创建相应的主机对象the agents. Use the same names for host and endpoint objects.

(root@icinga2-master1.localdomain /etc/icinga2/zones.d/master]# vim hosts.conf object Host "icinga2-agent1.localdomain" { check_command = "hostalive" address = "192.168.56.111" vars.agent_endpoint = name //follows the convention that host name == endpoint name } object Host "icinga2-agent2.localdomain" { check_command = "hostalive" address = "192.168.56.112" vars.agent_endpoint = name //follows the convention that host name == endpoint name }

Add services using command endpoint checks:

(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" // Check is executed on the remote command endpoint command_endpoint = host.vars.agent_endpoint assign where host.vars.agent_endpoint }

Validate the configuration and restart Icinga 2 on the master nodeicinga2-master1.localdomain.

[root@icinga2-master1.localdomain /]# icinga2 daemon -C [root@icinga2-master1.localdomain /]# systemctl restart icinga2

Open Icinga Web 2 and check the two newly created agent hosts with two new services – one executed locally (ping4) and one using command endpoint (disk).

Tip:

It’s a good idea to addhealth checksto make sure that your cluster notifies you in case of failure.

In terms of health checks, consider adding the following for this scenario:

• Master node(s) check the connection to the agents
• Optional: Add dependencies for the agent host to prevent unwanted notifications when agents are unreachable

Proceed inthis chapter.

Three Levels with Masters, Satellites and Agents¶

This scenario combines everything you’ve learned so far: High-availability masters, satellites receiving their configuration from the master zone, and agents checked via command endpoint from the satellite zones.

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!

There are various reasons why you might want to have satellites in your environment. The following list explains the more common ones.

• Monitor remote locations. Besides reducing connections and traffic between different locations this setup also helps when the network connection to the remote network is lost. Satellites will keep checking and collecting data on their own and will send their check results when the connection is restored.
• Reduce connections between security zones. Satellites in a different zone (e.g. DMZ) than your masters will help reduce connections through firewalls.
• Offload resource hungry checks to other hosts. In very big setups running lots of plugins on your masters or satellites might have a significant impact on the performance during times of high load. You can introduce another level of satellites just to run these plugins and send their results to the upstream hosts.

Best practice is to run the database backend on a dedicated server/cluster and only expose a virtual IP address to Icinga and the IDO feature. By default, only one endpoint will actively write to the backend then. Typical setups for MySQL clusters involve Master-Master-Replication (Master-Slave-Replication in both directions) or Galera, more tips can be found on ourcommunity forums.

Overview:

• icinga2-master1.localdomain是configuration master master node.
• icinga2-master2.localdomain是secondary master master node without configuration inzones.d.
• icinga2-satellite1.localdomainandicinga2-satellite2.localdomainare satellite nodes in amasterchild zone. They forward CSR signing requests to the master zone.
• icinga2-agent1.localdomainandicinga2-agent2.localdomainare two child nodes as agents.

Setup requirements:

• Set upicinga2-master1.localdomainasmaster.
• Set upicinga2-master2.localdomain,icinga2-satellite1.localdomainandicinga2-satellite2.localdomainasagents(we will modify the generated configuration).
• Set upicinga2-agent1.localdomainandicinga2-agent2.localdomainasagents.

When being asked for the parent endpoint providing CSR auto-signing capabilities, please add one of the satellite nodes.Note: This requires Icinga 2 v2.8+ and theCA Proxyon all master, satellite and agent nodes.

Example foricinga2-agent1.localdomain:

Please specify the parent endpoint(s) (master or satellite) where this node should connect to:

Parent endpoint is the first satelliteicinga2-satellite1.localdomain:

Master/Satellite Common Name (CN from your master/satellite node): icinga2-satellite1.localdomain Do you want to establish a connection to the parent node from this node? [Y/n]: y Please specify the master/satellite connection information: Master/Satellite endpoint host (IP address or FQDN): 192.168.56.105 Master/Satellite endpoint port [5665]: 5665

Add the second satelliteicinga2-satellite2.localdomainas parent:

Add more master/satellite endpoints? [y/N]: y Master/Satellite Common Name (CN from your master/satellite node): icinga2-satellite2.localdomain Do you want to establish a connection to the parent node from this node? [Y/n]: y Please specify the master/satellite connection information: Master/Satellite endpoint host (IP address or FQDN): 192.168.56.106 Master/Satellite endpoint port [5665]: 5665 Add more master/satellite endpoints? [y/N]: n

The specified parent nodes will forward the CSR signing request to the master instances.

Proceed with adding the optional client ticket forCSR auto-signing:

Please specify the request ticket generated on your Icinga 2 master (optional). (Hint: # icinga2 pki ticket --cn 'icinga2-agent1.localdomain'): 4f75d2ecd253575fe9180938ebff7cbca262f96e

In case you’ve chosen to useOn-Demand CSR Signingyou 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 forconfig sync mode) and commands (required forcommand endpoint mode).

Accept config from parent node? [y/N]: y Accept commands from parent node? [y/N]: y

Next you can optionally specify the local and parent zone names. This will be reflected in the generated zone configuration file.

Local zone name [icinga2-agent1.localdomain]: icinga2-agent1.localdomain

Set the parent zone name tosatellitefor this agent.

Parent zone name [master]: satellite

You can add more global zones in addition toglobal-templatesanddirector-globalif necessary. PressEnteror choosen, if you don’t want to add any additional.

Reconfiguring Icinga... Default global zones: global-templates director-global Do you want to specify additional global zones? [y/N]: N

Last but not least the wizard asks you whether you want to disable the inclusion of the local configuration directory inconf.d, or not. Defaults to disabled, since agents are checked via command endpoint and the example configuration would collide with this mode.

Do you want to disable the inclusion of the conf.d directory [Y/n]: Y Disabling the inclusion of the conf.d directory...

We’ll discuss the details of the required configuration below. Most of this configuration can be rendered by the setup wizards.

The zone hierarchy can look like this. We’ll define only the directly connected zones here.

The master instances should actively connect to the satellite instances, therefore the configuration onicinga2-master1.localdomainandicinga2-master2.localdomainmust include thehostattribute for the satellite endpoints:

(root@icinga2-master1.localdomain /) # vim /etc/icinga2/zones.conf object Endpoint "icinga2-master1.localdomain" { // That's us } object Endpoint "icinga2-master2.localdomain" { host = "192.168.56.102" // Actively connect to the second master. } object Endpoint "icinga2-satellite1.localdomain" { host = "192.168.56.105" // Actively connect to the satellites. } object Endpoint "icinga2-satellite2.localdomain" { host = "192.168.56.106" // Actively connect to the satellites. } object Zone "master" { endpoints = [ "icinga2-master1.localdomain", "icinga2-master2.localdomain" ] }

The endpoint configuration on the secondary master looks similar, but changes the connection attributes - the first master already tries to connect, there is no need for a secondary attempt.

[root@icinga2-master2.localdomain /]# vim /etc/icinga2/zones.conf object Endpoint "icinga2-master1.localdomain" { // First master already connects to us } object Endpoint "icinga2-master2.localdomain" { // That's us } object Endpoint "icinga2-satellite1.localdomain" { host = "192.168.56.105" // Actively connect to the satellites. } object Endpoint "icinga2-satellite2.localdomain" { host = "192.168.56.106" // Actively connect to the satellites. }

The zone configuration on both masters looks the same. Add this to the correspondingzones.confentries for the endpoints.

object Zone "satellite" { endpoints = [ "icinga2-satellite1.localdomain", "icinga2-satellite2.localdomain" ] parent = "master" } /* sync global commands */ object Zone "global-templates" { global = true } object Zone "director-global" { global = true }

In contrast to that, the satellite instancesicinga2-satellite1.localdomainandicinga2-satellite2.localdomainshould not actively connect to the master instances.

[root@icinga2-satellite1.localdomain /]# vim /etc/icinga2/zones.conf object Endpoint "icinga2-master1.localdomain" { // This endpoint will connect to us } object Endpoint "icinga2-master2.localdomain" { // This endpoint will connect to us } object Endpoint "icinga2-satellite1.localdomain" { // That's us } object Endpoint "icinga2-satellite2.localdomain" { host = "192.168.56.106" // Actively connect to the secondary satellite }

Again, only one side is required to establish the connection inside the HA zone. Since satellite1 already connects to satellite2, leave out thehostattribute foricinga2-satellite1.localdomainon satellite2.

[root@icinga2-satellite2.localdomain /]# vim /etc/icinga2/zones.conf object Endpoint "icinga2-master1.localdomain" { // This endpoint will connect to us } object Endpoint "icinga2-master2.localdomain" { // This endpoint will connect to us } object Endpoint "icinga2-satellite1.localdomain" { // First satellite already connects to us } object Endpoint "icinga2-satellite2.localdomain" { // That's us }

The zone configuration on both satellites looks the same. Add this to the correspondingzones.confentries for the endpoints.

object Zone "master" { endpoints = [ "icinga2-master1.localdomain", "icinga2-master2.localdomain" ] } object Zone "satellite" { endpoints = [ "icinga2-satellite1.localdomain", "icinga2-satellite2.localdomain" ] parent = "master" } /* sync global commands */ object Zone "global-templates" { global = true } object Zone "director-global" { global = true }

Keep in mind to control the endpointconnection directionusing thehostattribute, also for other endpoints in the same zone.

Since we want to usetop down command endpointchecks, we must configure the agent endpoint and zone objects.

In order to minimize the effort, we’ll sync the agent zone and endpoint configuration to the satellites where the connection information is needed as well. Note: This only works with satellite and agents, since there already is a trust relationship between the master and the satellite zone. The cluster config sync to the satellite invokes an automated reload causing the agent connection attempts.

icinga2-master1.localdomain是configuration master where everything is stored:

[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-agent1.localdomain.conf object Endpoint "icinga2-agent1.localdomain" { host = "192.168.56.111" // The satellite actively tries to connect to the agent log_duration = 0 // Disable the replay log for command endpoint agents } object Zone "icinga2-agent1.localdomain" { endpoints = [ "icinga2-agent1.localdomain" ] parent = "satellite" } [root@icinga2-master1.localdomain /etc/icinga2/zones.d/satellite]# vim icinga2-agent2.localdomain.conf object Endpoint "icinga2-agent2.localdomain" { host = "192.168.56.112" // The satellite actively tries to connect to the agent log_duration = 0 // Disable the replay log for command endpoint agents } object Zone "icinga2-agent2.localdomain" { endpoints = [ "icinga2-agent2.localdomain" ] parent = "satellite" }

The two agent nodes do not need to know about each other. The only important thing is that they know about the parent zone (the satellite) and their endpoint members (and optionally the global zone).

Tipp

In the example above we’ve specified thehostattribute in the agent endpoint configuration. In this mode, the satellites actively connect to the agents. This costs some resources on the satellite – if you prefer to offload the connection attempts to the agent, or your DMZ requires this, you can also change theconnection direction.

1) Don’t set thehostattribute for the agent endpoints put intozones.d/satellite. 2) Modify each agent’s zones.conf file and add thehostattribute to all parent satellites. You can automate this with using thenode wizard/setupCLI commands.

The agents are waiting for the satellites to connect, therefore they don’t specify thehostattribute in the endpoint objects locally.

Example foricinga2-agent1.localdomain:

[root@icinga2-agent1.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-agent1.localdomain" { // That's us } object Zone "satellite" { endpoints = [ "icinga2-satellite1.localdomain", "icinga2-satellite2.localdomain" ] } object Zone "icinga2-agent1.localdomain" { endpoints = [ "icinga2-agent1.localdomain" ] parent = "satellite" } /* sync global commands */ object Zone "global-templates" { global = true } object Zone "director-global" { global = true }

Example foricinga2-agent2.localdomain:

[root@icinga2-agent2.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-agent2.localdomain" { // That's us } object Zone "satellite" { endpoints = [ "icinga2-satellite1.localdomain", "icinga2-satellite2.localdomain" ] } object Zone "icinga2-agent2.localdomain" { endpoints = [ "icinga2-agent2.localdomain" ] parent = "satellite" } /* sync global commands */ object Zone "global-templates" { global = true } object Zone "director-global" { global = true }

现在是时候来定义两个代理主机在the master, sync them to the satellites and apply service checks using the command endpoint execution method to them. Add the two agent nodes as host objects to thesatellitezone.

We’ve already created the directories in/etc/icinga2/zones.dincluding the files for the zone and endpoint configuration for the agents.

(root@icinga2-master1.localdomain /) # cd /etc/icinga2/zones.d/satellite

Add the host object configuration for theicinga2-agent1.localdomainagent. You should have created the configuration file in the previous steps and it should contain the endpoint and zone object configuration already.

(root@icinga2-master1.localdomain /etc/icinga2/zones.d/satellite]# vim icinga2-agent1.localdomain.conf object Host "icinga2-agent1.localdomain" { check_command = "hostalive" address = "192.168.56.111" vars.agent_endpoint = name // Follows the convention that host name == endpoint name }

Add the host object configuration for theicinga2-agent2.localdomainagent configuration file:

(root@icinga2-master1.localdomain /etc/icinga2/zones.d/satellite]# vim icinga2-agent2.localdomain.conf object Host "icinga2-agent2.localdomain" { check_command = "hostalive" address = "192.168.56.112" vars.agent_endpoint = name // Follows the convention that host name == endpoint name }

Add a service object which is executed on the satellite nodes (e.g.ping4). Pin the apply rule to thesatellitezone only.

(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 }

Add services using command endpoint checks. Pin the apply rules to thesatellitezone only.

(root@icinga2-master1.localdomain /etc/icinga2/zones.d/satellite]# vim services.conf apply Service "disk" { check_command = "disk" // Execute the check on the remote command endpoint command_endpoint = host.vars.agent_endpoint assign where host.zone == "satellite" && host.vars.agent_endpoint }

Validate the configuration and restart Icinga 2 on the master nodeicinga2-master1.localdomain.

[root@icinga2-master1.localdomain /]# icinga2 daemon -C [root@icinga2-master1.localdomain /]# systemctl restart icinga2

Open Icinga Web 2 and check the two newly created agent hosts with two new services – one executed locally (ping4) and one using command endpoint (disk).

Tip:

It’s a good idea to addhealth checksto make sure that your cluster notifies you in case of failure.

In terms of health checks, consider adding the following for this scenario:

• Master nodes check whether the satellite zone is connected
• Satellite nodes check the connection to the agents
• Optional: Add dependencies for the agent host to prevent unwanted notifications when agents are unreachable

Proceed inthis chapter.

Best Practice¶

We’ve put together a collection of configuration examples from community feedback. If you like to share your tips and tricks with us, please join thecommunity channels!

Global Zone for Config Sync¶

Global zones can be used to sync generic configuration objects to all nodes depending on them. Common examples are:

• Templates which are imported into zone specific objects.
• Command objects referenced by Host, Service, Notification objects.
• Apply rules for services, notifications and dependencies.
• User objects referenced in notifications.
• Group objects.
• TimePeriod objects.

Plugin scripts and binaries must not 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 keeping packages and scripts uptodate.

Note:支票对象(主机和服务)不能put into a global zone. The configuration validation will terminate with an error. Apply rules work as they are evaluated locally on each endpoint.

The zone object configuration must be deployed on all nodes which should receive the global configuration files:

(root@icinga2-master1.localdomain /) # vim /etc/icinga2/zones.conf object Zone "global-commands" { global = true }

The default global zones generated by the setup wizards are calledglobal-templatesanddirector-global.

While you can and should useglobal-templatesfor your global configuration,director-globalis reserved for use byIcinga Director. Please don’t place any configuration in it manually.

Similar to the zone configuration sync you’ll need to create a new directory in/etc/icinga2/zones.d:

[root@icinga2-master1.localdomain /]# mkdir -p /etc/icinga2/zones.d/global-commands

Next, add a new check command, for example:

(root@icinga2-master1.localdomain /) # vim /etc/icinga2/zones.d/global-commands/web.conf object CheckCommand "webinject" { //... }

Restart the endpoints(s) which should receive the global zone before before restarting the parent master/satellite nodes.

Then validate the configuration on the master node and restart Icinga 2.

Tip: You can copy the example configuration files located in/etc/icinga2/conf.dinto the default global zoneglobal-templates.

Example:

(root@icinga2-master1.localdomain /) # cd /etc/icinga2/conf.d [root@icinga2-master1.localdomain /etc/icinga2/conf.d]# cp {commands,groups,notifications,services,templates,timeperiods,users}.conf /etc/icinga2/zones.d/global-templates

Health Checks¶

In case of network failures or other problems, your monitoring might either have late check results or just send out mass alarms for unknown checks.

In order to minimize the problems caused by this, you should configure additional health checks.

cluster-zone with Masters and Agents¶

Thecluster-zonecheck will test whether the configured target zone is currently connected or not. This example adds a health check for theha master with agents scenario.

(root@icinga2-master1.localdomain /) # vim /etc/icinga2/zones.d/master/services.conf apply Service "agent-health" { check_command = "cluster-zone" display_name = "cluster-health-" + host.name /* This follows the convention that the agent zone name is the FQDN which is the same as the host object name. */ vars.cluster_zone = host.name assign where host.vars.agent_endpoint }

In order to prevent unwanted notifications, add a service dependency which gets applied to all services using the command endpoint mode.

(root@icinga2-master1.localdomain /) # vim /etc/icinga2/zones.d/master/dependencies.conf apply Dependency "agent-health-check" to Service { parent_service_name = "agent-health" states = [ OK ] // Fail if the parent service state switches to NOT-OK disable_notifications = true assign where host.vars.agent_endpoint // Automatically assigns all agent endpoint checks as child services on the matched host ignore where service.name == "agent-health" // Avoid a self reference from child to parent }

cluster-zone with Masters, Satellites and Agents¶

This example adds health checks for themaster, satellites and agents scenario.

每当主人,坐在之间的联系ellite zone breaks, you may encounter late check results in Icinga Web. In order to view this failure and also send notifications, add the following configuration:

First, add the two masters as host objects to the master zone, if not already existing.

(root@icinga2-master1.localdomain /) # vim /etc/icinga2/zones.d/master/hosts.conf object Host "icinga2-master1.localdomain" { check_command = "hostalive" address = "192.168.56.101" } object Host "icinga2-master2.localdomain" { check_command = "hostalive" address = "192.168.56.102" }

Add service health checks against the satellite zone.

(root@icinga2-master1.localdomain /) # vim /etc/icinga2/zones.d/master/health.conf apply Service "satellite-zone-health" { check_command = "cluster-zone" check_interval = 30s retry_interval = 10s vars.cluster_zone = "satellite" assign where match("icinga2-master*.localdomain", host.name) }

Don’t forget to create notification apply rules for these services.

Next are health checks for agents connected to the satellite zone. Navigate into the satellite directory inzones.d:

(root@icinga2-master1.localdomain /) # cd /etc/icinga2/zones.d/satellite

You should already have configured agent host objects followingthe master, satellite, agents scenario. Add a new configuration file where all the health checks are defined.

(root@icinga2-master1.localdomain /etc/icinga2/zones.d/satellite]# vim health.conf apply Service "agent-health" { check_command = "cluster-zone" display_name = "agent-health-" + host.name // This follows the convention that the agent zone name is the FQDN which is the same as the host object name. vars.cluster_zone = host.name // Create this health check for agent hosts in the satellite zone assign where host.zone == "satellite" && host.vars.agent_endpoint }

In order to prevent unwanted notifications, add a service dependency which gets applied to all services using the command endpoint mode.

(root@icinga2-master1.localdomain /etc/icinga2/zones.d/satellite]# vim health.conf apply Dependency "agent-health-check" to Service { parent_service_name = "agent-health" states = [ OK ] // Fail if the parent service state switches to NOT-OK disable_notifications = true assign where host.zone == "satellite" && host.vars.agent_endpoint // Automatically assigns all agent endpoint checks as child services on the matched host ignore where service.name == "agent-health" // Avoid a self reference from child to parent }

This is all done on the configuration master, and requires the scenario to be fully up and running.

Cluster Check¶

Theclustercheck will check if all endpoints in the current zone and the directly connected zones are working properly. The disadvantage of using this check is that you cannot monitor 3 or more cluster levels with it.

[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 object Service "cluster" { check_command = "cluster" check_interval = 5s retry_interval = 1s host_name = "icinga2-master1.localdomain" }

Pin Checks in a Zone¶

In case you want to pin specific checks to their endpoints in a given zone you’ll need to use thecommand_endpointattribute. This is reasonable if you want to execute a local disk check in themasterZone on a specific endpoint then.

[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) }

Thehost.zoneattribute check inside the expression ensures that the service object is only created for host objects inside themasterzone. In addition to that thematchfunction ensures to only create services for the master nodes.

Windows Firewall¶

ICMP Requests¶

By default ICMP requests are disabled in the Windows firewall. You can change that byadding a new rule.

C:\> netsh advfirewall firewall add rule name="ICMP Allow incoming V4 echo request" protocol=icmpv4:8,any dir=in action=allow

Icinga 2¶

If your master/satellite nodes should actively connect to the Windows agent you’ll also need to ensure that port5665is enabled.

C:\> netsh advfirewall firewall add rule name="Open port 5665 (Icinga 2)" dir=in action=allow protocol=TCP localport=5665

NSClient++ API¶

If thecheck_nscp_apiplugin is used to query NSClient++, you need to ensure that its port is enabled.

C:\> netsh advfirewall firewall add rule name="Open port 8443 (NSClient++ API)" dir=in action=allow protocol=TCP localport=8443

For security reasons, it is advised to enable the NSClient++ HTTP API for local connection from the Icinga agent only. Remote connections to the HTTP API are not recommended with using the legacy HTTP API.

Windows Agent and Plugins¶

The Icinga 2 package on Windows already provides several plugins. Detaileddocumentationis available for all check command definitions.

Based on themaster with agentsscenario we’ll now add a local disk check.

First, add the agent node as host object:

(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-agent2.localdomain" { check_command = "hostalive" address = "192.168.56.112" vars.agent_endpoint = name //follows the convention that host name == endpoint name vars.os_type = "windows" }

Next, add the disk check using command endpoint checks (details in thedisk-windowsdocumentation):

(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.agent_endpoint assign where host.vars.os_type == "windows" && host.vars.agent_endpoint }

Validate the configuration and restart Icinga 2.

[root@icinga2-master1.localdomain /]# icinga2 daemon -C [root@icinga2-master1.localdomain /]# systemctl restart icinga2

Open Icinga Web 2 and check your newly added Windows disk check :)

如果你想添加你自己的plugins please checkthis chapterfor the requirements.

Windows Agent and NSClient++¶

There are two methods available for querying NSClient++:

• Query theHTTP APIlocally from an Icinga agent (requires a running NSClient++ service)
• 运行alocal CLI check(does not require NSClient++ as a service)

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.

NSCLient++ with check_nscp_api¶

TheWindows setupalready allows you to install the NSClient++ package. In addition to the Windows plugins you can use thenscp_api commandprovided by the Icinga Template Library (ITL).

的初始设置NSClient + + API和required arguments is the described in the ITL chapter for thenscp_apiCheckCommand.

Based on themaster with agentsscenario we’ll now add a local nscp check which queries the NSClient++ API to check the free disk space.

Define a host object calledicinga2-agent2.localdomainon the master. Add thenscp_api_passwordcustom variable 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-agent1.localdomain" { check_command = "hostalive" address = "192.168.56.111" vars.agent_endpoint = name //follows the convention that host name == endpoint name vars.os_type = "Windows" vars.nscp_api_password = "icinga" vars.drives = [ "C:", "D:" ] }

The service checks are generated using anapply forrule based onhost.vars.drives:

(root@icinga2-master1.localdomain /etc/icinga2/zones.d/master]# vim services.conf apply Service "nscp-api-" for (drive in host.vars.drives) { import "generic-service" check_command = "nscp_api" command_endpoint = host.vars.agent_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.

Note: You can also omit thecommand_endpointconfiguration to execute the command on the master. This also requires a different value fornscp_api_hostwhich defaults tohost.address.

//command_endpoint = host.vars.agent_endpoint //vars.nscp_api_host = "localhost"

You can verify the check execution by looking at theCheck Sourceattribute in Icinga Web 2 or the REST API.

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-agent1.localdomain" { check_command = "hostalive" address = "192.168.56.111" vars.agent_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.agent_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" }

NSCLient++ with nscp-local¶

TheWindows setupallows you to install the bundled NSClient++ package. In addition to the Windows plugins you can use thenscp-local commandsprovided by the Icinga Template Library (ITL).

Add the followingincludestatement on all your nodes (master, satellite, agent):

vim /etc/icinga2/icinga2.conf include 

The CheckCommand definitions will automatically determine the installed path to thenscp.exebinary.

Based on themaster with agentsscenario we’ll now add a local nscp check querying a given performance counter.

First, add the agent node as host object:

(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-agent1.localdomain" { check_command = "hostalive" address = "192.168.56.111" vars.agent_endpoint = name //follows the convention that host name == endpoint name vars.os_type = "windows" }

Next, add a performance counter check using command endpoint checks (details in thenscp-local-counterdocumentation):

(root@icinga2-master1.localdomain /etc/icinga2/zones.d/master]# vim services.conf apply Service "nscp-local-counter-cpu" { check_command = "nscp-local-counter" command_endpoint = host.vars.agent_endpoint 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 vars.nscp_counter_showall = true assign where host.vars.os_type == "windows" && host.vars.agent_endpoint }

Validate the configuration and restart Icinga 2.

[root@icinga2-master1.localdomain /]# icinga2 daemon -C [root@icinga2-master1.localdomain /]# systemctl restart icinga2

Open Icinga Web 2 and check your newly added Windows NSClient++ check :)

Tip

In order to measure CPU load, you’ll need a running NSClient++ service. Therefore it is advised to use a localnscp-apicheck against its REST API.

Advanced Hints¶

You can find additional hints in this section if you prefer to go your own route with automating setups (setup, certificates, configuration).

Certificate Auto-Renewal¶

Icinga 2 v2.8+ added 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. You’ll also see a message in the logs if certificate renewal isn’t necessary.

High-Availability for Icinga 2 Features¶

All nodes in the same zone require that you enable the same features for high-availability (HA).

By default, the following features provide advanced HA functionality:

• Checks(load balanced, automated failover).
• Notifications(load balanced, automated failover).
• DB IDO(Run-Once, automated failover).
• Elasticsearch
• Gelf
• Graphite
• InfluxDB(v1 and v2)
• OpenTsdb
• Perfdata(for PNP)

High-Availability with Checks¶

All instances within the same zone (e.g. themasterzone as HA cluster) must have thecheckerfeature enabled.

Example:

icinga2featureenablechecker

All nodes in the same zone load-balance the check execution. If one instance shuts down, the other nodes will automatically take over the remaining checks.

High-Availability with Notifications¶

All instances within the same zone (e.g. themasterzone as HA cluster) must have thenotificationfeature enabled.

Example:

icinga2featureenablenotification

Notifications are load-balanced amongst all nodes in a zone. By default this functionality is enabled. If your nodes should send out notifications independently from any other nodes (this will cause duplicated notifications if not properly handled!), you can setenable_ha = falsein theNotificationComponentfeature.

High-Availability with DB IDO¶

All instances within the same zone (e.g. themasterzone as HA cluster) must have the DB IDO feature enabled.

DB被罩MySQL示例:

icinga2featureenableido-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.

Note: The DB IDO HA feature can be disabled by setting theenable_haattribute tofalsefor theIdoMysqlConnectionorIdoPgsqlConnectionobject onallnodes in thesamezone.

All endpoints will enable the DB IDO feature and connect to the configured database and dump configuration, status and historical data on their own.

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 by running the following query command:

icinga=> SELECT status_update_time, endpoint_name FROM icinga_programstatus; status_update_time | endpoint_name ------------------------+--------------- 2016-08-15 15:52:26+02 | icinga2-master1.localdomain (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 thefailover_timeoutattribute, but not lower than 60 seconds.

Endpoint Connection Direction¶

Endpoints attempt to connect to another endpoint when its localEndpointobject configuration specifies a validhostattribute (FQDN or IP address).

Example for the master nodeicinga2-master1.localdomainactively connecting to the agent nodeicinga2-agent1.localdomain:

(root@icinga2-master1.localdomain /) # vim /etc/icinga2/zones.conf //... object Endpoint "icinga2-agent1.localdomain" { host = "192.168.56.111" // The master actively tries to connect to the agent log_duration = 0 // Disable the replay log for command endpoint agents }

Example for the agent nodeicinga2-agent1.localdomainnot actively connecting to the master nodeicinga2-master1.localdomain:

[root@icinga2-agent1.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 // Disable the replay log for command endpoint agents }

It is not necessary that both the master and the agent node establish two connections to each other. Icinga 2 will only use one connection and close the second connection if established. This generates useless CPU cycles and leads to blocking resources when the connection times out.

Tip: Choose either to let master/satellite nodes connect to agent nodes or vice versa.

Disable Log Duration for Command Endpoints¶

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.

This functionality is not needed when a master/satellite node is sending check execution events to an agent which is configured ascommand endpointfor check execution.

TheEndpointobject attributelog_durationcan be lower or set to 0 to fully disable any log replay updates when the agent is not connected.

Configuration on the master nodeicinga2-master1.localdomain:

(root@icinga2-master1.localdomain /) # vim /etc/icinga2/zones.conf //... object Endpoint "icinga2-agent1.localdomain" { host = "192.168.56.111" // The master actively tries to connect to the agent log_duration = 0 } object Endpoint "icinga2-agent2.localdomain" { host = "192.168.56.112" // The master actively tries to connect to the agent log_duration = 0 }

Configuration on the agenticinga2-agent1.localdomain:

[root@icinga2-agent1.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 }

Initial Sync for new Endpoints in a Zone¶

Note

This is required if you decide to change an already running single endpoint production environment into a HA-enabled cluster zone with two endpoints. Theinitial setupwith 2 HA masters doesn’t require this step.

In order to make sure that all of your zone endpoints have the same state you need to pick the authoritative running one and copy the following content:

• State file from/var/lib/icinga2/icinga2.state
• Internal config package for runtime created objects (downtimes, comments, hosts, etc.) at/var/lib/icinga2/api/packages/_api

If you need already deployed config packages from the Director, or synced cluster zones, you can also sync the entire/var/lib/icinga2/api/packagesdirectory. This directory should also be included in your backup strategy.

Donotsync/var/lib/icinga2/api/zones*手动——这是一个内部目录和handled by the Icinga cluster config sync itself.

Note

Ensure that all endpoints are shut down during this procedure. Once you have synced the cached files, proceed with configuring the remaining endpoints to let them know about the new master/satellite node (zones.conf).

Manual Certificate Creation¶

Create CA on the Master¶

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

Create CSR and Certificate¶

Create a certificate signing request (CSR) for the local instance:

[root@icinga2-master1.localdomain /root]# icinga2 pki new-cert --cn icinga2-master1.localdomain \ --key icinga2-master1.localdomain.key \ --csr icinga2-master1.localdomain.csr

Sign the CSR with the previously created CA:

[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.

Copy Certificates¶

Copy the host’s certificate files and the public CA certificate to/var/lib/icinga2/certs:

[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

Ensure that proper permissions are set (replaceicingawith the Icinga 2 daemon user):

[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

The CA public and private key are stored in the/var/lib/icinga2/cadirectory. Keep this path secure and include it in your backups.

Create Multiple Certificates¶

Use your preferred method to automate the certificate generation process.

[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'.

Copy and move these certificates to the respective instances e.g. with SSH/SCP.

Automation¶

These hints should get you started with your own automation tools (Puppet, Ansible, Chef, Salt, etc.) or custom scripts for automated setup.

These are collected best practices from various community channels.

• Silent Windows setup
• Node Setup CLI commandwith parameters

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). This will tremendously help when someone is trying to help in thecommunity channels.

Silent Windows Setup¶

If you want to install the agent silently/unattended, use the/qnmodifier. The installation should not trigger a restart, but if you want to be completely sure, you can use the/norestartmodifier.

C:> msiexec /i C:\Icinga2-v2.5.0-x86.msi /qn /norestart

Once the setup is completed you can use thenode setupcli command too.

Node Setup using CLI Parameters¶

Instead of using thenode wizardCLI command, there is an alternativenode setupcommand available which has some prerequisites.

Note: The CLI command can be used on Linux/Unix and Windows operating systems. The graphical Windows setup wizard actively uses these CLI commands.

Node Setup on the Master Node¶

In case you want to setup a master node you must add the--masterparameter to thenode setupCLI command. In addition to that the--cncan optionally be passed (defaults to the FQDN).

Example:

(root@icinga2-master1.localdomain /) # icinga2节点setup --master

In case you want to bind theApiListenerobject to a specific host/port you can specify it like this:

--listen 192.68.56.101,5665

In case you don’t need anything inconf.d, use the following command line:

(root@icinga2-master1.localdomain /) # icinga2节点setup --master --disable-confd

Node Setup with Agents/Satellites¶

Preparations¶

Make sure that the/var/lib/icinga2/certsdirectory exists and is owned by theicingauser (or the user Icinga 2 is running as).

[root@icinga2-agent1.localdomain /]# mkdir -p /var/lib/icinga2/certs [root@icinga2-agent1.localdomain /]# chown -R icinga:icinga /var/lib/icinga2/certs

First you’ll need to generate a new local self-signed certificate. Pass the following details to thepki new-certCLI command:

Example:

[root@icinga2-agent1.localdomain /]# icinga2 pki new-cert --cn icinga2-agent1.localdomain \ --key /var/lib/icinga2/certs/icinga2-agent1.localdomain.key \ --cert /var/lib/icinga2/certs/icinga2-agent1.localdomain.crt

Verify Parent Connection¶

In order to verify the parent connection and avoid man-in-the-middle attacks, fetch the parent instance’s certificate and verify that it matches the connection. Thetrusted-parent.crtfile is a temporary file passed tonode setupin the next step and does not need to be stored for later usage.

Pass the following details to thepki save-certCLI command:

Request the master certificate from the master host (icinga2-master1.localdomain) and store it astrusted-parent.crt. Review it and continue.

[root@icinga2-agent1.localdomain /]# icinga2 pki save-cert \ --trustedcert /var/lib/icinga2/certs/trusted-parent.crt \ --host icinga2-master1.localdomain information/cli: Retrieving TLS certificate for 'icinga2-master1.localdomain:5665'. Subject: CN = icinga2-master1.localdomain Issuer: CN = icinga2-master1.localdomain Valid From: Feb 4 08:59:05 2020 GMT Valid Until: Jan 31 08:59:05 2035 GMT Fingerprint: B4 90 DE 46 81 DD 2E BF EE 9D D5 47 61 43 EF C6 6D 86 A6 CC *** *** You have to ensure that this certificate actually matches the parent *** instance's certificate in order to avoid man-in-the-middle attacks. *** information/pki: Writing certificate to file '/var/lib/icinga2/certs/trusted-parent.crt'.

Node Setup¶

Continue with the additionalnode setupstep. Specify a local endpoint and zone name (icinga2-agent1.localdomain) and set the master host (icinga2-master1.localdomain) as parent zone configuration. Specify the path to the previously stored trusted parent certificate (trusted-parent.crt).

Pass the following details to thenode setupCLI command:

Note

Themaster_hostparameter is deprecated and will be removed. Please use--parent_hostinstead.

Example:

[root@icinga2-agent1.localdomain /]# icinga2 node setup --ticket ead2d570e18c78abf285d6b85524970a0f69c22d \ --cn icinga2-agent1.localdomain \ --endpoint icinga2-master1.localdomain \ --zone icinga2-agent1.localdomain \ --parent_zone master \ --parent_host icinga2-master1.localdomain \ --trustedcert /var/lib/icinga2/certs/trusted-parent.crt \ --accept-commands --accept-config \ --disable-confd

In case the agent/satellite should connect to the master node, you’ll need to modify the--endpointparameter using the formatcn,host,port:

--endpoint icinga2-master1.localdomain,192.168.56.101,5665

Specify the parent zone using the--parent_zoneparameter. This is useful if the agent connects to a satellite, not the master instance.

--parent_zone satellite

In case the agent should know the additional global zonelinux-templates, you’ll need to set the--global-zonesparameter.

--global_zones linux-templates

The--parent-hostparameter 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 agent/satellite which performs a certificate update in-memory.

In case you did not provide a ticket, you need tomanually sign the CSR on the master nodewhich holds the CA’s key pair.

You can find additional best practices below.

If this agent node is configured asremote command endpoint executionyou can safely disable thecheckerfeature. Thenode setupCLI command already disabled thenotificationfeature.

[root@icinga2-agent1.localdomain /]# icinga2 feature disable checker

Optional: Add an ApiUser object configuration for remote troubleshooting.

[root@icinga2-agent1.localdomain /]# cat </etc/icinga2/conf.d/api-users.conf object ApiUser "root" { password = "agentsupersecretpassword" permissions = ["*"] } EOF

Finally restart Icinga 2.

[root@icinga2-agent1.localdomain /]# systemctl restart icinga2

Your automation tool must then configure master node in the meantime.

# cat <>/etc/icinga2/zones.conf object Endpoint "icinga2-agent1.localdomain" { // Agent connects itself } object Zone "icinga2-agent1.localdomain" { endpoints = [ "icinga2-agent1.localdomain" ] parent = "master" } EOF

Using Multiple Environments¶

Note

This documentation only covers the basics. Full functionality requires a not yet released addon.

In some cases it can be desired to run multiple Icinga instances on the same host. Two potential scenarios include:

• Different versions of the same monitoring configuration (e.g. production and testing)
• Disparate sets of checks for entirely unrelated monitoring environments (e.g. infrastructure and applications)

The configuration is done with the global constantsApiBindHostandApiBindPortor thebind_hostandbind_portattributes of theApiListenerobject.

The environment must be set with the global constantEnvironmentor as object attribute of theIcingaApplicationobject.

In any case the constant is default value for the attribute and the direct configuration in the objects have more precedence. The constants have been added to allow the values being set from the CLI on startup.

When Icinga establishes a TLS connection to another cluster instance it automatically uses theSNI扩展to signal which endpoint it is attempting to connect to. On its own this can already be used to position multiple Icinga instances behind a load balancer.

SNI example:icinga2-agent1.localdomain

However, if the environment is configured toproduction, Icinga appends the environment name to the SNI hostname like this:

SNI example with environment:icinga2-agent1.localdomain:production

Middleware like loadbalancers or TLS proxies can read the SNI header and route the connection to the appropriate target. I.e., it uses a single externally-visible TCP port (usually 5665) and forwards connections to one or more Icinga instances which are bound to a local TCP port. It does so by inspecting the environment name that is sent as part of the SNI extension.