github/runbooks
1
0
Fork 0
mirror of https://github.com/prometheus-operator/runbooks.git synced 2026-02-14 16:59:52 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Move guidelines section to add-runbook, add local testing info

Browse Source 
Signed-off-by: Mac Chaffee <me@macchaffee.com>
This commit is contained in:
Mac Chaffee
2022-02-02 22:05:46 -05:00
parent fd91cb155c
commit 166e7c437d
3 changed files with 16 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@@ -1,2 +1,3 @@
public/
resources/
.hugo_build.lock

13
README.md
View File

@@ -4,15 +4,4 @@ This repo contains the official [runbooks](https://en.wikipedia.org/wiki/Runbook
The live version can be found at https://runbooks.prometheus-operator.dev/
## Contributing
To edit or expand an existing runbook, feel free to edit the files under `content/` and submit a pull request.
To create a new runbook, see [add-runbook.md](./content/docs/add-runbook.md).
## Guidelines
The purpose of this repository is to have a documentation about every alert shipped by kube-prometheus (not only by prometheus-operator). In the long run, we are aiming to support as many k8s flavors as possible. If possible try to ensure the 'Diagnosis/Mitigation' sections are applicable to all certified kubernetes distributions.
The primary target for these runbooks are folks who are novices and don't have much insight into what to do with alerts shipped in kube-prometheus. As a result, try to avoid excessive jargon and abbreviations.
For information about contributing, see [add-runbook.md](./content/docs/add-runbook.md).

14
content/docs/add-runbook.md
View File

@@ -72,3 +72,17 @@ Is this some irregular condition, e.g. a process fails to clean up behind itself
[1]: https://github.github.com/gfm/#html-block
```
### Guidelines
The purpose of this repository is to have a documentation about every alert shipped by kube-prometheus (not only by prometheus-operator). In the long run, we are aiming to support as many k8s flavors as possible. If possible try to ensure the 'Diagnosis/Mitigation' sections are applicable to all certified kubernetes distributions.
The primary target for these runbooks are folks who are novices and don't have much insight into what to do with alerts shipped in kube-prometheus. As a result, try to avoid excessive jargon and abbreviations.
### Testing locally
To test your changes locally:
1. Install [Hugo](https://gohugo.io/getting-started/installing/)
2. Run `git submodule init` and `git submodule update` to clone the Hugo theme
3. Run `hugo server` and navigate to http://localhost:1313/ in your browser