Document using K9s on the seed

azimuth-cloud · Jul 8, 2024 · 9139073 · 9139073
1 parent c52c393
commit 9139073
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 0 deletions.
diff --git a/docs/debugging/k9s-all-pods.png b/docs/debugging/k9s-all-pods.png
diff --git a/docs/debugging/k9s-default-pods.png b/docs/debugging/k9s-default-pods.png
diff --git a/docs/debugging/k9s-pod-logs.png b/docs/debugging/k9s-pod-logs.png
diff --git a/docs/debugging/using-k9s.md b/docs/debugging/using-k9s.md
@@ -0,0 +1,37 @@
+# Using K9s
+
+K9s is installed onto the seed VM. You can use this for a more interractive
+view of the Kubernetes clusters. From the seed, either run `k9s` with
+`KUBECONFIG` unset to view the K3s cluster, or export the provided `KUBECONFIG`
+file to view the HA cluster.
+
+```console
+$ ./bin/seed-ssh
+ubuntu@azimuth-staging-seed:~$ export KUBECONFIG=./kubeconfig-azimuth-staging.yaml
+ubuntu@azimuth-staging-seed:~$ k9s
+```
+
+By default, you are viewing the pods in the default namespace.
+
+![Pods view in K9s](k9s-default-pods.png)
+
+Here's some simple commands to get started:
+
+* View all namespaces by pressing `0`.
+
+  ![All pods in K9s](k9s-all-pods.png)
+
+* Select a pod with the arrow keys and view its logs with `l`.
+
+  ![capo-controller logs in K9s](k9s-pod-logs.png)
+
+* Switch between resources with `:<resource-type>`. For example:
+
+  ```console
+  :machines
+  :clusters
+  :pods
+  ```
+
+
+See the [k9s docs](https://k9scli.io/) for more details.