update docs for nerdctl support

Co-authored-by: Sean McGinnis <[email protected]>
Signed-off-by: Kay Yan <[email protected]>

.github/ISSUE_TEMPLATE/bug-report.md

@@ -21,7 +21,7 @@ labels: kind/bug
 **Environment:**
 
 - kind version: (use `kind version`):
-- Runtime info: (use `docker info` or `podman info`):
+- Runtime info: (use `docker info`, `podman info` or `nerdctl info`):
 - OS (e.g. from `/etc/os-release`):
 - Kubernetes version: (use `kubectl version`):
 - Any proxies or other special environment settings?:

README.md

@@ -5,7 +5,7 @@
 kind is a tool for running local Kubernetes clusters using Docker container "nodes".
 kind was primarily designed for testing Kubernetes itself, but may be used for local development or CI.
 
-If you have [go] 1.16+ and [docker] or [podman] installed `go install sigs.k8s.io/[email protected] && kind create cluster` is all you need!
+If you have [go] 1.16+ and [docker], [podman] or [nerdctl] installed `go install sigs.k8s.io/[email protected] && kind create cluster` is all you need!
 
 ![](site/static/images/kind-create-cluster.png)
 
@@ -145,6 +145,7 @@ Participation in the Kubernetes community is governed by the [Kubernetes Code of
 [go-supported]: https://golang.org/doc/devel/release.html#policy
 [docker]: https://www.docker.com/
 [podman]: https://podman.io/
+[nerdctl]: https://github.com/containerd/nerdctl
 [community page]: https://kubernetes.io/community/
 [Kubernetes Code of Conduct]: code-of-conduct.md
 [Go Report Card Badge]: https://goreportcard.com/badge/sigs.k8s.io/kind

site/content/_index.md

@@ -6,7 +6,7 @@ title: kind
 [kind] is a tool for running local Kubernetes clusters using Docker container "nodes".  
 kind was primarily designed for testing Kubernetes itself, but may be used for local development or CI.
 
-If you have [go] 1.16+ and [docker] or [podman] installed `go install sigs.k8s.io/kind@{{< stableVersion >}} && kind create cluster` is all you need!
+If you have [go] 1.16+ and [docker], [podman] or [nerdctl] installed `go install sigs.k8s.io/kind@{{< stableVersion >}} && kind create cluster` is all you need!
 
 <img src="images/kind-create-cluster.png" />
 
@@ -95,6 +95,7 @@ Participation in the Kubernetes community is governed by the [Kubernetes Code of
 [go-supported]: https://golang.org/doc/devel/release.html#policy
 [docker]: https://www.docker.com/
 [podman]: https://podman.io/
+[nerdctl]: https://github.com/containerd/nerdctl
 [community page]: https://kubernetes.io/community/
 [Kubernetes Code of Conduct]: https://github.com/kubernetes/community/blob/master/code-of-conduct.md
 [Go Report Card Badge]: https://goreportcard.com/badge/sigs.k8s.io/kind

site/content/docs/contributing/development.md

@@ -153,7 +153,7 @@ with kind at HEAD to have the latest fixes for running bleeding edge Kubernetes.
 We ensure that the tests continue to work in the kind repo before merging any code changes.
 
 We also have some limited usage experiments with [GitHub Actions], currently
-only for testing `podman` support in kind.
+only for testing `podman` or `nerdctl` support in kind.
 
 ### Configuration
 

site/content/docs/user/rootless.md

@@ -6,11 +6,12 @@ menu:
     identifier: "rootless"
     weight: 3
 ---
-Starting with kind 0.11.0, [Rootless Docker](https://docs.docker.com/go/rootless/) and [Rootless Podman](https://github.com/containers/podman/blob/master/docs/tutorials/rootless_tutorial.md) can be used as the node provider of kind.
+Starting with kind 0.11.0, [Rootless Docker](https://docs.docker.com/go/rootless/), [Rootless Podman](https://github.com/containers/podman/blob/master/docs/tutorials/rootless_tutorial.md) and [Rootless nerdctl](https://github.com/containerd/nerdctl/blob/main/docs/rootless.md) can be used as the node provider of kind.
 
 ## Provider requirements
 - Docker: 20.10 or later
 - Podman: 3.0 or later
+- nerdctl: 1.7 or later
 
 ## Host requirements
 The host needs to be running with cgroup v2.
@@ -80,5 +81,12 @@ On some distributions, you might need to use systemd-run to start kind into its
 $ systemd-run --scope --user kind create cluster
 ```
 
+## Creating a kind cluster with Rootless nerdctl
+
+To create a kind cluster with nerdctl, just run:
+```console
+$ KIND_EXPERIMENTAL_PROVIDER=nerdctl kind create cluster
+```
+
 ## Tips
 - To enable OOM watching, allow `dmesg` by running `sysctl -w kernel.dmesg_restrict=0`.