docs: add how-to guide for debugging Kubernetes charms#2498
docs: add how-to guide for debugging Kubernetes charms#2498tonyandrewmeyer wants to merge 11 commits into
Conversation
There was a problem hiding this comment.
Thanks for compiling this! I need to review in more detail, but have taken a first pass.
I think it would be easier for people to orient themselves if we move "Common failure modes" nearer the beginning of the doc - probably after "Know which container you’re looking at". I think that section is a great quick reference and should be (slightly) expanded by migrating other content from around the doc.
I've commented on the pieces I think we should move.
My thinking is that we should make a cleaner split between the why and the how. If you already know why you need to be reading a particular section, there should be minimal intro text. Get right into the how. But if you don't know which section you should be reading, "Common failure modes" points you in the right direction and helps you understand why.
Let me know if you'd like to discuss this suggestion together. I'm also very happy to experiment with different structures if that would help.
|
@dwilding could you take another look when you have some time? No rush :) |
Co-authored-by: Dave Wilding <tech@dpw.me>
- Replace `--`/`;` connectives with full stops in the symptoms table. - Promote the workload-container SSH command to its own subsection. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2 participants
This PR adds a follow-on guide to the recent how-to for debugging, specifically focused on K8s charms and using Pebble.
At the recent sprints we received a couple of comments that more information was needed for debugging in this specific case, so this is addressing those.
The main focus is on Pebble, but there's a little bit for K8s directly, without going all the way into being a guide for debugging K8s itself.
Preview
Fixes #2489