Skip to content
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

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

Open
nvtkaszpir opened this issue Feb 19, 2022 · 3 comments
Open

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

nvtkaszpir opened this issue Feb 19, 2022 · 3 comments

Comments

@nvtkaszpir
Copy link
Contributor

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 ?

@aantn
Copy link

aantn commented Feb 21, 2022

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.

@paulfantom
Copy link
Member

paulfantom commented Feb 22, 2022

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.

@aantn
Copy link

aantn commented Feb 27, 2022

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants