refactor: finish moving ssh-* scripts to own installers
[webi-installers/.git] / kind / README.md
1 ---
2 title: kind
3 homepage: https://github.com/kubernetes-sigs/kind
4 tagline: |
5   kind: tool for running local Kubernetes clusters using Docker container "nodes".
6 ---
7
8 To update or switch versions, run `webi kind@stable` (or `@v2`, `@beta`,etc).
9
10 ## Cheat Sheet
11
12 > Kind uses a single docker container to run a lightweight kubernetes cluster
13 > for testing and shenanigans
14
15 User Guide - Quick Start: https://kind.sigs.k8s.io/docs/user/quick-start
16
17 To create a cluster with default name
18
19 ```bash
20 kind create cluster
21 ```
22
23 Create a cluster with a specific name
24
25 ```bash
26 kind create cluster --name foo
27 ```
28
29 List clusters
30
31 ```bash
32 kind get clusters
33 ```
34
35 Specify Kubernetes version
36
37 ```bash
38 kind create cluster --image "kindest/node:$favoriteTag"
39 ```
40
41 - pick your \$favoriteTag from here:
42   https://hub.docker.com/r/kindest/node/tags?page=1&ordering=last_updated
43
44 Export all logs from a cluster
45
46 ```bash
47 kind exports logs $HOME/somedir
48 ```
49
50 To delete a cluster with default name
51
52 ```bash
53 kind delete cluster
54 ```
55
56 To delete a cluster with specific name
57
58 ```bash
59 kind delete cluster --name foo
60 ```
61
62 Get the kubeconfig of a cluster
63
64 ```bash
65 kind get kubeconfig --name foo
66 ```