Added k9s installer

[webi-installers/.git] / k9s / README.md

diff --git a/k9s/README.md b/k9s/README.md
new file mode 100644 (file)
index 0000000..b11050d
--- /dev/null
+++ b/k9s/README.md
@@ -0,0 +1,56 @@
+---
+title: K9s
+homepage: https://github.com/derailed/k9s
+tagline: |
+  K9s provides a terminal UI to interact with your Kubernetes clusters
+---
+
+### Updating `k9s`
+
+`webi k9s@stable`
+
+Use the `@beta` tag for pre-releases.
+
+## Cheat Sheet
+
+> `k9s` aim is to make it easier to navigate, observe and manage your applications in the wild. K9s continually watches Kubernetes for changes and offers subsequent commands to interact with your observed resources.
+
+### Preflight check
+
+K9s uses 256 colors terminal mode. On `Nix system make sure TERM is set accordingly.
+
+```bash
+export TERM=xterm-256color
+```
+
+To run k9s:
+```bash
+k9s
+```
+
+### Command line arguments
+
+List all available CLI options
+```bash
+k9s help
+```
+
+To get info about K9s runtime (logs, configs, etc..)
+```bash
+k9s info
+```
+
+To run K9s in a given namespace
+```bash
+k9s -n mycoolns
+```
+
+Start K9s in an existing KubeConfig context
+```bash
+k9s --context coolCtx
+```
+
+Start K9s in readonly mode - with all cluster modification commands disabled
+```bash
+k9s --readonly
+```
\ No newline at end of file