[dev.icinga.com #12386] Rewrite Client and Cluster chapter and; add service monitoring chapter

[icinga-migration]

This issue has been migrated from Redmine: https://dev.icinga.com/issues/12386

Created by mfriedrich on 2016-08-09 14:31:22 +00:00

Assignee: mfriedrich
Status: Resolved (closed on 2016-08-20 18:35:04 +00:00)
Target Version: 2.5.0
Last Update: 2016-11-25 14:29:42 +00:00 (in Redmine)

Backport?: Not yet backported
Include in Changelog: 1

---

• basics with images on Zone/Endpoint relationships
• how do the names fit (endpoints, CN, etc)
• simple setup with a master and a client using command_endpoint
  Involves setup steps for Linux and Windows
  plugin installation
• pick examples for a simple existing check (Linux, Windows)
• Explain global templates and CheckCommands by adding an additional plugin
• advanced setup with a satellite and config sync
• additional example with a HA cluster - explain HA features (IDO)
• additional example with a 3 level cluster (master, satellite, client; mention CSR autosigning issue)
• additional example with bottom-up node list/update-config
• health checks
• best practices

Helpful forum threads

https://monitoring-portal.org/index.php?thread/37006-certificate-issue-for-a-icinga-rookie/&postID=234213#post234213
https://monitoring-portal.org/index.php?thread/37003-a-very-basic-low-level-understanding-question/&postID=233971#post233978
https://monitoring-portal.org/index.php?thread/36994-anf%C3%A4ngerprobleme-vars-os-vom-client-im-server-zus%C3%A4tzliche-checks-vom-server-aus/
https://monitoring-portal.org/index.php?thread/36971-icinga2-remote-hosts-tresholds/
https://monitoring-portal.org/index.php?thread/36936-windows-and-zone-configurations/
https://monitoring-portal.org/index.php?thread/36786-verst%C3%A4ndnis-der-command-execution-bridge/
https://monitoring-portal.org/index.php?thread/37031-problem-beim-master-satellite-client-setup-mit-icinga2-node-wizard/&postID=234156#post234156
etc.

Changesets

2016-08-14 15:56:38 +00:00 by mfriedrich 4a3b33e

Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter

Also apply a new structure.

Deleted the old cluster and client documentation and started "fresh".

This commit also includes various images used in the newly written
"Distributed Monitoring" chapter for better understanding.

fixes #12386

2016-08-18 10:45:22 +00:00 by mfriedrich 6542d21

Docs: Fix service monitoring formatting; add VMWare timeout hint

refs #12386

2016-08-20 12:17:18 +00:00 by hej 8c3f605

Docs: Review service monitoring and distributed monitoring chapters, part I

refs #12386

2016-08-20 18:31:13 +00:00 by mfriedrich ed71284

Docs: Review service monitoring and distributed monitoring chapters, part II

Kudos to sru and the kind feedback from monitoring-portal.org users.

fixes #12386

2016-08-21 10:43:28 +00:00 by mfriedrich 6741cb0

Docs: Fix typos, formatting, phrasing

refs #12386

2016-08-22 07:59:44 +00:00 by mfriedrich 4c419d0

Docs: Small addition for endpoint explanation

refs #12498
refs #12386

---

Relations:

• relates #12386
• relates #12386

[icinga-migration]

Updated by mfriedrich on 2016-08-11 09:18:57 +00:00

• Description updated

[icinga-migration]

Updated by mfriedrich on 2016-08-12 06:54:55 +00:00

• Description updated

[icinga-migration]

Updated by mfriedrich on 2016-08-14 15:56:21 +00:00

• Subject changed from Rewrite Client and Cluster docs to Rewrite Client and Cluster chapter and; add service monitoring chapter
• Target Version set to 2.5.0

I've now dropped the entire cluster and client documentation chapters and have rewritten them from scratch. 14 hours making the docs better.

This did not go as planned this weekend, but my personal demand is to have the docs in good shape for 2.5. It will also ensure that the community support gets better - currently there are >5 questions asked a week about setting up the clients.

Distributed Monitoring

Setup

Cli commands are now used everywhere, especially "node wizard" for the setup. Everything which means "advanced" (node setup, or pki new-cert) is moved to the end of the chapter.

I have re-used the Windows installation chapter including the screenshots from 2.4.5 (nothing changed there). The Linux bits have been tested and rewritten from scratch. This unveiled several small errors in there as well.

Configuration Modes

We've seen lots of users and customers going the command endpoint route, or generally speaking "top down" (that description can be found quite often and so we are using it inside the documentation now as well).

In addition to that, the previous "cluster config sync" is now a general config sync as part of the "top down" understanding.

There are also users which use "node update-config". This has been founded to be called "bottom up", and gets its own chapter.

Scenarios

I've also created new images which should help understand the entire cluster structure.

The scenarios for different kind of setups have been identified from community feedback and customer setups. They provide real world examples and graphics to explain what the configuration is supposed to be meaning.

Best Practices

-> health checks, global zones

I've even found the time to put some more examples for monitoring Windows clients - either with native windows plugins provided by Icinga 2 or by using the nscp-local CheckCommand objects.

Advanced Hints

manuel certificate creation, silent windows install, node setup cli params (recycled from the old content), etc.

Conclusion

The new structure also reflects better what users want after they've successfully installed and configured the basic checks.

-> service monitoring and plugins (add your own plugin)

This involves all the contributed monitoring plugin check commands we've collected over time. It will also help users getting an idea about basic topics and serves as a base for white paper urls for detailed service monitoring description.

-> distributed monitoring with master, satellite, client setup

The big one.

-> additional agent checks

Partially recycled it from the old chapter.

-> advanced topics
-> object types, ITL
-> cli, API

[icinga-migration]

Updated by mfriedrich on 2016-08-14 16:00:04 +00:00

• Status changed from Assigned to Resolved
• Done % changed from 0 to 100

Applied in changeset 4a3b33e.

[icinga-migration]

Updated by mfriedrich on 2016-08-14 16:21:29 +00:00

http://docs.icinga.org/icinga2/snapshot/doc/module/icinga2/toc#!/icinga2/snapshot/doc/module/icinga2/chapter/service-monitoring
http://docs.icinga.org/icinga2/snapshot/doc/module/icinga2/toc#!/icinga2/snapshot/doc/module/icinga2/chapter/distributed-monitoring

[icinga-migration]

Updated by mfriedrich on 2016-08-15 13:21:35 +00:00

• Relates set to 12433

[icinga-migration]

Updated by mfriedrich on 2016-08-18 10:34:33 +00:00

• Status changed from Resolved to Assigned
• Done % changed from 100 to 90

Final Review with suggestions pending.

#92

[icinga-migration]

Updated by mfriedrich on 2016-08-18 17:51:03 +00:00

https://monitoring-portal.org/index.php?thread/37121-apply-plugins-nagios-from-the-master-to-3-remote-client-nodes-doens-t-seems-to-w/&postID=234682#post234682

• notes on my desk.

[icinga-migration]

Updated by mfriedrich on 2016-08-18 17:57:17 +00:00

Add a section with "how to write your own plugin" into "service monitoring".

[icinga-migration]

Updated by mfriedrich on 2016-08-20 18:26:27 +00:00

Add an automation chapter for clients as well.

[icinga-migration]

Updated by mfriedrich on 2016-08-20 18:35:04 +00:00

• Status changed from Assigned to Resolved
• Done % changed from 90 to 100

Applied in changeset ed71284.

[icinga-migration]

Updated by mfriedrich on 2016-08-22 08:33:15 +00:00

• Relates set to 12498

[icinga-migration]

Updated by mfriedrich on 2016-11-25 14:29:42 +00:00

• Parent Id deleted 11413