Skip to content

Commit

Permalink
update docs for nerdctl support
Browse files Browse the repository at this point in the history
Signed-off-by: Kay Yan <[email protected]>

Co-authored-by: Sean McGinnis <[email protected]>
  • Loading branch information
yankay and stmcginnis committed Feb 28, 2024
1 parent 7c3e01f commit caa0643
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?:
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion site/content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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" />

Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/contributing/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit caa0643

Please sign in to comment.