Enhance documentation regarding internal icinga config sync check #10101
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Explicitly name the config-sync check feature of the icinga check, as before this was a little bit too undocumented making it unknown to me. Also mention where the check has to executed in order to bring the desired results.
Add 4h typical error point for configuration stored outside of /etc/icinga2/zones.d. For when a non-distributed setup was migrated to a distributed setup. Also link to the internal icinga CheckCommand to promote its existance.
Remove "-" from link
This reverts commit bb25ba3.
|
I wasn't sure if I should mention the icinga CheckCommand in the technical concept describing the config sync. However I'm pleased to do so if you think it makes sense: https://icinga.com/docs/icinga-2/latest/doc/19-technical-concepts/#config-sync |
oxzi
reviewed
Jul 24, 2024
There was a problem hiding this comment.
Thank you for using Icinga all these years and trying to improve the experience of other users.
I have added some small notes, please take a look.
Edit: Please add yourself to the AUTHORS file with the username and email used in your commit, as noted by the check https://github.com/Icinga/icinga2/actions/runs/10063806426/job/27848891798?pr=10101.
Add myself to AUTHORS
Co-authored-by: alvar <[email protected]>
Co-authored-by: alvar <[email protected]>
Co-authored-by: alvar <[email protected]>
|
Hi @oxzi the changes are fine for me. Thank you! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi,
I had the problem that I converted my non-distributed monitoring to a distributed one. That worked fine for years, but due to a new NotificationCommand I noticed that I had defined a necessary Token inside /etc/icinga2/constants.conf file, which of course is not synced to the satellites/agents.
I only noticed this a few weeks after these changes, as another new service check wasn't being rolled out to the agents.
(Small homelab environment, not many changes are happening.)
After figuring this all out I learned only through the Community forum that the internal icinga CheckCommand checks for successful config syncs IF it is executed on the satellites/agents. Which was not the case in my scenario as I didn't properly migrate that service for a redundant setup.
However.. The documentation on this is very sparse. The config file sync check is only named indirectly and you only understand what that means when you already know what the CheckCommand does. - Not really helpful.
Also the troubleshooting section made no mention of that.
With this commit I try to fix these 2 minor issues. Hoping other people will spot their errors faster than me. ;-)