Skip to content

Commit dfa14aa

Browse files
MoteHueJohnGarbutt
andcommitted
Document using K9s on the seed (azimuth-cloud#159)
Co-authored-by: John Garbutt <[email protected]>
1 parent 8c07d8e commit dfa14aa

File tree

5 files changed

+38
-0
lines changed

5 files changed

+38
-0
lines changed

docs/debugging/k9s-all-pods.png

127 KB
Loading
52.1 KB
Loading

docs/debugging/k9s-pod-logs.png

84.5 KB
Loading

docs/debugging/using-k9s.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Using K9s
2+
3+
K9s is installed onto the seed VM. You can use this for a more interactive view
4+
of the Kubernetes clusters. From the seed, either run `k9s` with `KUBECONFIG`
5+
unset to view the K3s cluster, or export the provided `KUBECONFIG` file to view
6+
the HA cluster.
7+
8+
```console
9+
$ ./bin/seed-ssh
10+
ubuntu@azimuth-staging-seed:~$ export KUBECONFIG=./kubeconfig-azimuth-staging.yaml
11+
ubuntu@azimuth-staging-seed:~$ k9s
12+
```
13+
14+
By default, you are viewing the pods in the default namespace.
15+
16+
![Pods view in K9s](k9s-default-pods.png)
17+
18+
Here's some simple commands to get started:
19+
20+
* View all namespaces by pressing `0`.
21+
22+
![All pods in K9s](k9s-all-pods.png)
23+
24+
* Select a pod with the arrow keys and view its logs with `l`.
25+
26+
![capo-controller logs in K9s](k9s-pod-logs.png)
27+
28+
* Switch between resources with `:<resource-type>`. For example:
29+
30+
```console
31+
:machines
32+
:clusters
33+
:pods
34+
```
35+
36+
37+
See the [k9s docs](https://k9scli.io/) for more details.

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ nav:
4141
- debugging/index.md
4242
- debugging/access-k3s.md
4343
- debugging/access-ha.md
44+
- debugging/using-k9s.md
4445
- debugging/access-monitoring.md
4546
- debugging/zenith-services.md
4647
- debugging/consul.md

0 commit comments

Comments
 (0)