refactor: finish moving ssh-* scripts to own installers

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

diff --git a/kind/README.md b/kind/README.md
index 648a3b3e961fb8b819eb00ace64fd1e8e06dff70..59e7742ca3086674202482657de08c60535338d0 100644 (file)
--- a/kind/README.md
+++ b/kind/README.md
@@ -9,12 +9,58 @@ To update or switch versions, run `webi kind@stable` (or `@v2`, `@beta`,etc).
 
 ## Cheat Sheet
 
-To create a cluster 
+> Kind uses a single docker container to run a lightweight kubernetes cluster
+> for testing and shenanigans
+
+User Guide - Quick Start: https://kind.sigs.k8s.io/docs/user/quick-start
+
+To create a cluster with default name
+
 ```bash
 kind create cluster
 ```
 
-To delete a cluster 
+Create a cluster with a specific name
+
+```bash
+kind create cluster --name foo
+```
+
+List clusters
+
+```bash
+kind get clusters
+```
+
+Specify Kubernetes version
+
+```bash
+kind create cluster --image "kindest/node:$favoriteTag"
+```
+
+- pick your \$favoriteTag from here:
+  https://hub.docker.com/r/kindest/node/tags?page=1&ordering=last_updated
+
+Export all logs from a cluster
+
+```bash
+kind exports logs $HOME/somedir
+```
+
+To delete a cluster with default name
+
 ```bash
 kind delete cluster
-```
\ No newline at end of file
+```
+
+To delete a cluster with specific name
+
+```bash
+kind delete cluster --name foo
+```
+
+Get the kubeconfig of a cluster
+
+```bash
+kind get kubeconfig --name foo
+```