From f91c262b01cd2e7a4380fb89ad1bd0b75e18627c Mon Sep 17 00:00:00 2001 From: Devin Buhl Date: Fri, 3 Feb 2023 17:51:38 -0500 Subject: [PATCH] chore: add common debugging section in readme Signed-off-by: Devin Buhl --- README.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 292f3064..65f4b696 100644 --- a/README.md +++ b/README.md @@ -533,10 +533,27 @@ kubectl -n monitoring get secret kubernetes-dashboard -o jsonpath='{.data.token} You should be able to access the dashboard at `https://kubernetes.${SECRET_DOMAIN}` +## 🐛 Debugging + +Below is a general guide on trying to debug an issue with an resource or application. For example, if a workload/resource is not showing up or a pod has started but in a `CrashLoopBackOff` or `Pending` state. + +1. Start by checking all Flux Kustomizations and verify they are healthy. + - `flux get ks -A` +2. Then check all the Flux Helm Releases and verify they are healthy. + - `flux get hr -A` +3. Then check the if the pod is present. + - `kubectl -n get pods` +4. Then check the logs of the pod if its there. + - `kubectl -n logs -f` + +Note: If a resource exists, running `kubectl -n describe ` should give you insight into what the problem(s) might be. + +Resolving problems that you see could take some tweaking of your YAML manifests in order to get things working, other times it could be a external factor like permissions on NFS. If you are unable to figure out your problem see the help section below. + ## 👉 Help -- [Discussions](https://github.com/onedr0p/flux-cluster-template/discussions) -- [Discord](https://discord.gg/k8s-at-home) +- Make a post in this repository's GitHub [Discussions](https://github.com/onedr0p/flux-cluster-template/discussions). +- Start a thread in the `support` or `flux-cluster-template` channel in the [k8s@home](https://discord.gg/k8s-at-home) Discord server. ## ❔ What's next