Join GitHub today
GitHub is home to over 36 million developers working together to host and review code, manage projects, and build software together.Sign up
[dev.icinga.com #12386] Rewrite Client and Cluster chapter and; add service monitoring chapter #4453
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
Helpful forum threads
2016-08-14 15:56:38 +00:00 by mfriedrich 4a3b33e
2016-08-18 10:45:22 +00:00 by mfriedrich 6542d21
2016-08-20 12:17:18 +00:00 by hej 8c3f605
2016-08-20 18:31:13 +00:00 by mfriedrich ed71284
2016-08-21 10:43:28 +00:00 by mfriedrich 6741cb0
2016-08-22 07:59:44 +00:00 by mfriedrich 4c419d0
Updated by mfriedrich on 2016-08-14 15:56:21 +00:00
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.
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.
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.
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.
-> 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.
manuel certificate creation, silent windows install, node setup cli params (recycled from the old content), etc.
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
Updated by mfriedrich on 2016-08-18 17:51:03 +00:00