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

Ideas #29

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

Ideas #29

nvtkaszpir opened this issue Feb 19, 2022 · 0 comments

Comments

@nvtkaszpir
Copy link
Contributor

nvtkaszpir commented Feb 19, 2022

Loose stream of thoughts.

1.Some runbooks have common debugging patterns, so there is no point in repeating them.
Extract as separate sections, maybe directory named /guides/ ?
This would be handy with example making a checklist when checking why pod is dead and so on.

  1. If possible link to official kubernetes docs.
    Officiak k8s are getting better and better, so it is better to direct people there, especially to Tasks section?

  2. Some more in-depth urls could be added to some runbooks.
    Looking especialy at issues with CpuThrottlingHigh.
    Not sure if this should be in auto-hidden section under Meaning or maybe add new section at the bottom such as References or Further Reading.

  3. Mitigation section should have Short Term such as 'fix issue now' and Long Term which is actually a post-mortem.
    Some alerts will require this, because are extremely problematic, especially those with data loss.

  4. add-runbook - link to some known articles
    https://gitlab.com/gitlab-com/runbooks
    https://github.com/danluu/post-mortems
    https://github.com/upgundecha/howtheysre

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

1 participant