-
Notifications
You must be signed in to change notification settings - Fork 597
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Initial Runbook Readme.md #26
Add Initial Runbook Readme.md #26
Conversation
Love it! I think as an MVP we should put the links in the alerts, and I see no problem with the being straight back to the github repo. WDYT?
Thats my philosophy too! This is a great starting point. |
Thanks! I do not currently speak ksonnet, so I'd rather have adding the links be a follow-up or get assistance. |
No worries I'm sure I can whip something up; mind if I push to this branch? |
Sounds great! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Content like this is typically licenced under creative commons, should we make a distinction here?
(apart from that there is no license specified at all in the repo, which we should fix @tomwilkie )
runbooks/README.md
Outdated
|
||
``` | ||
annotations: | ||
runbook: https://github.com/StevenACoffman/kubernetes-mixin/tree/master/runbooks#alert-name-kubeapidown |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can use the alert name in a template here, so we can just re-use the same runbook template link of all alerts.
Looking into this today |
Signed-off-by: Tom Wilkie <tom.wilkie@gmail.com>
Signed-off-by: Tom Wilkie <tom.wilkie@gmail.com>
Signed-off-by: Tom Wilkie <tom.wilkie@gmail.com>
I've added the magic to automatically add the links (yay jsonnet!), sorry it took so long. Let me know what you think @StevenACoffman @brancz! |
Signed-off-by: Tom Wilkie <tom.wilkie@gmail.com>
Ah! Your last commit fixed my ksonnet issue when I tested it out. LGTM |
Missed this - I say we keep it simple right now, one license for the repo. Will make a PR for license. |
I noticed that the monitoring-mixin rules/alerts don't come with any runbook links defined, which I feel is a missed opportunity. For an alert detecting standard problems, a link to a remediation (or at least description of the problem being measured) is very welcome.
I have not altered the ksonnet files to add the runbook annotations that are missing (compared to prometheus-operator rules), nor do I have a plan to automatically generate this markdown file from the ksonnet files if that's possible or desirable.
This is an initial effort, and I won't feel bad if someone does this better. I had not added meaningful descriptions to these alerts, but I hope that it can be improved over time.