From 09b0eea3fec3907f593d5249f15cd0b7bd36430e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Alfred=20G=C3=B6ppel?=
 <43101280+alfi0812@users.noreply.github.com>
Date: Sat, 8 Mar 2025 15:10:56 +0100
Subject: [PATCH] docs(troubleshooting) add an basic troubleshooting guide
 (#33003)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

**Description**
<!--
Please include a summary of the change and which issue is fixed. Please
also include relevant motivation and context. List any dependencies that
are required for this change.
-->
⚒️ Fixes  # <!--(issue)-->

**⚙️ Type of change**

- [ ] ⚙️ Feature/App addition
- [ ] 🪛 Bugfix
- [ ] ⚠️ Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] 🔃 Refactor of current code
- [x] 📜 Documentation Changes

**🧪 How Has This Been Tested?**
<!--
Please describe the tests that you ran to verify your changes. Provide
instructions so we can reproduce. Please also list any relevant details
for your test configuration
-->

**📃 Notes:**
<!-- Please enter any other relevant information here -->

**✔️ Checklist:**

- [ ] ⚖️ My code follows the style guidelines of this project
- [ ] 👀 I have performed a self-review of my own code
- [ ] #️⃣ I have commented my code, particularly in hard-to-understand
areas
- [x] 📄 I have made changes to the documentation
- [ ] 🧪 I have added tests to this description that prove my fix is
effective or that my feature works
- [ ] ⬆️ I increased versions for any altered app according to semantic
versioning
- [ ] I made sure the title starts with `feat(chart-name):`,
`fix(chart-name):`, `chore(chart-name):`, `docs(chart-name):` or
`fix(docs):`

**➕ App addition**

If this PR is an app addition please make sure you have done the
following.

- [ ] 🖼️ I have added an icon in the Chart's root directory called
`icon.png`

---

_Please don't blindly check all the boxes. Read them and only check
those that apply.
Those checkboxes are there for the reviewer to see what is this all
about and
the status of this PR with a quick glance._
---
 website/src/content/docs/guides/cheatsheet.md | 95 +++++++++++++++++++
 1 file changed, 95 insertions(+)
 create mode 100644 website/src/content/docs/guides/cheatsheet.md

diff --git a/website/src/content/docs/guides/cheatsheet.md b/website/src/content/docs/guides/cheatsheet.md
new file mode 100644
index 00000000000..267585a5651
--- /dev/null
+++ b/website/src/content/docs/guides/cheatsheet.md
@@ -0,0 +1,95 @@
+---
+title: Cluster Cheatsheet
+---
+
+This page contains a useful selection of commands to troubleshoot and manage your cluster.
+
+## Fluxcd
+
+Show all Flux Resources:
+
+```bash
+flux get all -A
+```
+
+Show all Kustomizations:
+
+```bash
+flux get ks -A
+```
+
+Show all Helm-Releases:
+
+```bash
+flux get hr -A
+```
+
+Show all Flux objects which are not ready:
+
+```bash
+flux get all -A --status-selector ready=false
+```
+
+## Helm
+
+Get Values from a running deployment:
+
+```bash
+helm get values -n <namespace> <deployment-name>
+```
+
+## Kubectl
+
+Most of the following commands can be adapted to either show all namespaces `-A` or only show a specific namespace with `-n <namespace>`. Examples use the all namespaces flag.
+Additionally you can use additional commands like `grep` to sort and filter your results.
+
+Show all Running Pods
+
+```bash
+kubectl get pods -A
+```
+
+Show all Services:
+
+```bash
+kubectl get svc -A
+```
+
+Show events:
+
+```bash
+kubectl get events -A
+```
+
+Describe a pod:
+
+```bash
+kubectl describe pod -n <namespace> podname
+```
+
+As you can see kubectl follows a certain pattern.
+The usual format is
+```bash
+kubectl (get/describe/delete/edit) <resource-type> -n <namespace>
+```
+
+An exception to this pattern is the logs command:
+
+```bash
+kubectl logs -n <namespace> <pod-name>
+```
+
+
+## Talosctl
+
+Show talos dashboard:
+
+```bash
+talosctl dashboard
+```
+
+Show talos kernel logs:
+
+```bash
+talosctl dmesg
+```