Skip to content
This repository was archived by the owner on Aug 7, 2025. It is now read-only.

Commit a5bb2d6

Browse files
committed
Rename 'kind' to 'kind-sysbox'
1 parent 3586717 commit a5bb2d6

File tree

3 files changed

+22
-21
lines changed

3 files changed

+22
-21
lines changed

dockerfiles/kindestnode/Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
#
1111
# Deploy with the K8s.io KinD tool:
1212
#
13-
# $ kind create cluster --image nestybox/kindestnode:v1.18.2
13+
# $ kind-sysbox create cluster --image nestybox/kindestnode:v1.18.2
1414
#
1515

1616
FROM kindest/node:v1.18.2

docs/quickstart/kind.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Here is a comparison for deploying a 10-node K8s cluster:
4242

4343
The sections below show examples of this.
4444

45-
## Using K8s.io KinD + Sysbox
45+
## Using K8s.io KinD + Sysbox (kind-sysbox)
4646

4747
<p align="center"><img alt="sysbox" src="../figures/kind-sysbox.png" width="800x" /></p>
4848

@@ -69,21 +69,22 @@ Unfortunately, you currently need a slightly modified version of the tool, as `k
6969
does not yet formally support Sysbox. We will be working with the community to
7070
add this support.
7171

72-
In the meantime, we forked the KinD tool [here](https://github.com/nestybox/kind)
73-
and made [tiny changes](https://github.com/nestybox/kind/commit/9708a130b7c0a539f2f3b5aa187137e71f747347)
74-
that enable it to work with Sysbox.
72+
In the meantime, we forked the KinD tool [here](https://github.com/nestybox/kind-sysbox)
73+
and made [tiny changes](https://github.com/nestybox/kind-sysbox/commit/9708a130b7c0a539f2f3b5aa187137e71f747347)
74+
that enable it to work with Sysbox. To avoid any confusion, we will refer to this modified
75+
version as 'kind-sysbox'.
7576

7677
Here are the steps to use KinD + Sysbox:
7778

7879
1) Download and build the modified KinD binary:
7980

8081
```console
81-
$ git clone https://github.com/nestybox/kind.git
82-
$ cd kind
83-
$ make kind
82+
$ git clone https://github.com/nestybox/kind-sysbox.git
83+
$ cd kind-sysbox
84+
$ make kind-sysbox
8485
```
8586

86-
The resulting binary is under `bin/kind`. Put that in your PATH.
87+
The resulting binary is under `bin/kind-sysbox`. Put that in your PATH.
8788

8889
2) Pull the `nestybox/kindestnode:v1.18.2` image.
8990

@@ -97,7 +98,7 @@ containers.
9798

9899
The Dockerfile is [here](../../dockerfiles/kindestnode).
99100

100-
3) Now simply tell `kind` to create the cluster.
101+
3) Now simply tell `kind-sysbox` to create the cluster.
101102

102103
```console
103104
$ more config.yaml
@@ -117,7 +118,7 @@ nodes:
117118
```
118119

119120
```console
120-
$ kind create cluster --image=nestybox/kindestnode:v1.18.2 --config=config.yaml
121+
$ kind-sysbox create cluster --image=nestybox/kindestnode:v1.18.2 --config=config.yaml
121122

122123
Creating cluster "kind" ...
123124
✓ Ensuring node image (nestybox/kindestnode:v1.18.2) 🖼
@@ -196,7 +197,7 @@ for a list of K8s functionality that works and doesn't when using Sysbox.
196197
To bring down the cluster, use:
197198

198199
```console
199-
$ kind delete cluster
200+
$ kind-sysbox delete cluster
200201

201202
Deleting cluster "kind" ...
202203
```
@@ -904,7 +905,7 @@ build process.
904905
5) Now deploy the K8s cluster using the newly created image:
905906

906907
```console
907-
$ kind create cluster --image kindestnode-with-inner-nginx
908+
$ kind-sysbox create cluster --image kindestnode-with-inner-nginx
908909
```
909910

910911
6) Verify the K8s cluster nodes have the inner nginx image in them:
@@ -980,7 +981,7 @@ $ docker stop k8s-node
980981
5) Launch the K8s cluster with KinD + Sysbox, using the newly committed image:
981982

982983
```console
983-
$ kind create cluster --image=kindestnode-with-inner-nginx:latest
984+
$ kind-sysbox create cluster --image=kindestnode-with-inner-nginx:latest
984985
```
985986

986987
6) Verify the K8s cluster nodes have the inner nginx image in them:
@@ -997,7 +998,7 @@ pod images into your K8s nodes.
997998

998999
One caveat however:
9991000

1000-
Doing a Docker commit of a running K8s node deployed via `kind create cluster`
1001+
Doing a Docker commit of a running K8s node deployed via `kind-sysbox create cluster`
10011002
won't work. The commit itself will complete, but the resulting image can't be
10021003
used in a new KinD cluster. The reason is that the committed image contains the
10031004
runtime configuration of the K8s node that is specific to the original cluster,

docs/user-guide/kind.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -118,24 +118,24 @@ When used with Sysbox, the capabilities of the K8s.io kind tool are enhanced:
118118
Unfortunately, the K8s.io kind tool does not yet formally support the Sysbox
119119
runtime. Nestybox will be working with the community to add this support.
120120

121-
In the meantime, we forked the K8s.io kind tool [here](https://github.com/nestybox/kind)
121+
In the meantime, we forked the K8s.io kind tool [here](https://github.com/nestybox/kind-sysbox)
122122
and made a few changes that enable it to work with Sysbox.
123123

124124
The changes are **very simple**: we just modify the way the K8s.io kind tool invokes
125125
Docker to deploy the K8s node containers. For example, we add
126126
`--runtime=sysbox-runc` to the Docker run command, and remove the `--privileged`
127-
flag. The diffs are [here](https://github.com/nestybox/kind/commit/9708a130b7c0a539f2f3b5aa187137e71f747347).
127+
flag. The diffs are [here](https://github.com/nestybox/kind-sysbox/commit/9708a130b7c0a539f2f3b5aa187137e71f747347).
128128

129129
### Modified K8s.io KinD Tool
130130

131131
Here is the process to download and build the forked version of the K8s.io kind
132132
tool:
133133

134-
$ git clone https://github.com/nestybox/kind.git
135-
$ cd kind
136-
$ make kind
134+
$ git clone https://github.com/nestybox/kind-sysbox.git
135+
$ cd kind-sysbox
136+
$ make kind-sysbox
137137

138-
The resulting binary is under `bin/kind`.
138+
The resulting binary is under `bin/kind-sysbox`.
139139

140140
### Modified K8s node image
141141

0 commit comments

Comments
 (0)