runbooks icon indicating copy to clipboard operation
runbooks copied to clipboard

Join forces with robusta-dev/alert-explanations/wiki

Open nvtkaszpir opened this issue 3 years ago • 3 comments

Found out https://github.com/robusta-dev/alert-explanations/wiki which is using only github wiki, but they also use kube-prometheus-stack (with their opinionated configuration, though). Right now there are only 3 pages there, mainly focused on CPUThrottlingHigh explanations.

Wondering if they would be eager to participate in making PR in this repo? WDYT @aantn ?

nvtkaszpir avatar Feb 19 '22 08:02 nvtkaszpir

Hi, thanks for tagging me.

We were planning to move from GitHub wikis to a proper wiki and add substantially more content. We have time and resources to work on this.

We're trying to cover in each wiki page not only what to do, but also how you can automate that troubleshooting process using AlertManager webhooks and the Robusta open source. (E.g. if you would run two kubectl commands to see why an alert is firing we can run them directly and send the output along with the alert. If you would use some decision tree to troubleshoot, we do that in code.)

So the wiki pages are both documentation on what to do, but also what Robusta automates for you.

Would that type of content related to Robusta be welcome in this runbooks wiki? It's all open source, MIT licensed, and can be used standalone without our cloud platform.

aantn avatar Feb 21 '22 10:02 aantn

I am all for joining forces. However, runbooks here need to be unopinionated in regards to 3rd party tooling as we would like to keep a neutral ground and focus on tools we ship in kube-prometheus.

Side note: we used wiki in the past (as can be seen in https://github.com/prometheus-operator/kube-prometheus/wiki/Runbooks) but decided to deprecate it due to high friction when it came to contributions.

paulfantom avatar Feb 22 '22 11:02 paulfantom

Understood. Not going to open a PR for our content at present (as it's intentionally opinionated) but happy to explore other ideas in the future.

aantn avatar Feb 27 '22 14:02 aantn