Skip to content

Commit 475d5c3

Browse files
committed
➕ Add docs for kind
1 parent 34569f0 commit 475d5c3

File tree

3 files changed

+59
-1
lines changed

3 files changed

+59
-1
lines changed

.vitepress/_sidebar.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ export default [
2828
items: [
2929
{ text: 'docker', link: '/tools/docker' },
3030
{ text: 'git', link: '/tools/git' },
31+
{ text: 'kind', link: '/tools/kind' },
3132
{ text: 'ssh', link: '/tools/ssh' },
3233
{ text: 'ws-cli', link: '/tools/ws-cli' },
3334
]

docs/tools/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ An additional list of terminal specific tools can be found on the
3838
| **[hadolint][]** | `>=2.12` | GPL 3 |
3939
| **[Helm][]** | `>=3.14` | Apache 2 |
4040
| **[Helm Diff][]** | `>=3.9` | Apache 2 |
41-
| **[kind][]** | `>=0.20` | Apache 2 |
41+
| **[kind][]** | `>=0.22` | Apache 2 |
4242
| **[kubectl][]** | `>=1.29` | Apache 2 |
4343
| **[KubeLinter][]** | `>=0.6` | Apache 2 |
4444
| **[oc][]** | `>=4.6` | Apache 2 |

docs/tools/kind.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
see:
3+
- name: Docker
4+
link: /tools/docker
5+
- name: All Configuration Options
6+
link: https://kind.sigs.k8s.io/docs/user/configuration
7+
---
8+
9+
# Kind
10+
11+
Kind *(Kubernetes IN Docker)* is a tool for running local Kubernetes clusters using
12+
Docker container as *nodes*.
13+
It is primarily used for testing Kubernetes itself, or for developing Kubernetes
14+
applications in a local environment.
15+
16+
::: warn
17+
The documentation below assumes you are **not** using [`sysbox`][sysbox] as you Docker
18+
runtime.
19+
:::
20+
21+
## Custom Configuration
22+
23+
Custom configuration can be stored in a `yaml` file of your choice and used with
24+
the `kind create cluster --config my-config.yaml`.
25+
26+
### Cluster IP
27+
28+
For security reasons, a *kind* cluster is configured by default to be accessible at
29+
`127.0.0.1`.
30+
When using a remote Docker engine, it's necessary to adjust this setting, as the IP
31+
address resolves to the internal address of the current *workspace*.
32+
33+
To make the cluster accessible on the network of the running host, change the listening
34+
address to `0.0.0.0` *(or to a specific host IP)*:
35+
36+
```yaml
37+
kind: Cluster
38+
apiVersion: kind.x-k8s.io/v1alpha4
39+
networking:
40+
apiServerAddress: 0.0.0.0
41+
# ... more custom configurations follow
42+
```
43+
44+
Once deployed, you will need to update the `KUBECONFIG` to communicate with the API server
45+
using the host IP for the `cluster.server` address.
46+
47+
```yaml
48+
apiVersion: v1
49+
clusters:
50+
- cluster:
51+
server: https://192.168.1.120:6443
52+
certificate-authority-data: DATA+OMITTED
53+
name: created-by-kind
54+
# ... more custom configurations follow
55+
```
56+
57+
[sysbox]: /tools/docker#_1-use-sysbox-suggested

0 commit comments

Comments
 (0)