Maksytka/kind
1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/kind.git synced 2025-11-30 23:16:04 +07:00
Code Issues Packages Projects Releases Wiki Activity

doc: fix paths.

Browse Source 
Signed-off-by: Jintao Zhang <zhangjintao9020@gmail.com>
This commit is contained in:
Jintao Zhang
2019-02-14 12:11:48 +08:00
parent 54ff8b1538
commit c622a73831
4 changed files with 29 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@@ -14,12 +14,12 @@ If you have [go] and [docker] installed `go get sigs.k8s.io/kind && kind create
<img src="https://gist.githubusercontent.com/BenTheElder/621bc321fc6d9506fd936feb36d32dd0/raw/7fe14e9d0929cab428929ca6c501abc990c07359/kind-create-cluster.gif" alt="2x speed `kind create cluster` demo" />
kind consists of:
- Go [packages][packages] implementing [cluster creation][cluster package], [image build][build package], etc.
- A command line interface ([`kind`][kind cli]) built on these packages.
- Docker [image(s)][images] written to run systemd, Kubernetes, etc.
- [`kubetest`][kubetest] integration also built on these packages (WIP)
- Go [packages][packages] implementing [cluster creation][cluster package], [image build][build package], etc.
- A command line interface ([`kind`][kind cli]) built on these packages.
- Docker [image(s)][images] written to run systemd, Kubernetes, etc.
- [`kubetest`][kubetest] integration also built on these packages (WIP)
kind bootstraps each "node" with [kubeadm][kubeadm]. For more details see [the design documentation][design doc].
kind bootstraps each "node" with [kubeadm][kubeadm]. For more details see [the design documentation][design doc].
**NOTE**: kind is still a work in progress, see [docs/roadmap.md].
@@ -61,12 +61,12 @@ See also: the Kubernetes [community page].
## Why kind?
- kind supports multi-node (including HA) clusters
- kind supports building Kubernetes release builds from source
- support for make / bash / docker, bazel, or installing from apt, in addition to pre-published builds.
- kind is written in go, and can be used as a library, has stable releases
- kind supports Windows in addition to MacOS and Linux
- kind is a [CNCF certified conformant Kubernetes installer](https://landscape.cncf.io/selected=kind)
- kind supports multi-node (including HA) clusters
- kind supports building Kubernetes release builds from source
- support for make / bash / docker, bazel, or installing from apt, in addition to pre-published builds.
- kind is written in go, and can be used as a library, has stable releases
- kind supports Windows in addition to MacOS and Linux
- kind is a [CNCF certified conformant Kubernetes installer](https://landscape.cncf.io/selected=kind)
## Alternatives
@@ -98,9 +98,8 @@ Participation in the Kubernetes community is governed by the [Kubernetes Code of
[images]: ./images
[kubetest]: https://github.com/kubernetes/test-infra/tree/master/kubetest
[kubeadm]: https://kubernetes.io/docs/reference/setup-tools/kubeadm/kubeadm/
[design doc]: ./docs/design/
[user guide]: ./docs/user/
[the docs]: ./docs
[design doc]: https://kind.sigs.k8s.io/docs/design/initial
[user guide]: https://kind.sigs.k8s.io/docs/user/quick-start
[SIG-Testing Mailing List]: https://groups.google.com/forum/#!forum/kubernetes-sig-testing
[issue tracker]: https://github.com/kubernetes-sigs/kind/issues
[filing an issue]: https://github.com/kubernetes-sigs/kind/issues/new

2
images/base/README.md
View File

@@ -18,4 +18,4 @@ See also [`pkg/cluster`](./../../pkg/cluster) for logic that interacts with this
## Design
See [docs/base-image.md](./../../docs/design/base-image.md) for more design details.
See [base-image](https://kind.sigs.k8s.io/docs/design/base-image/) for more design details.

4
images/node/README.md
View File

@@ -9,7 +9,7 @@ Roughly this image is [the base image](./../base), with the addition of:
- placing the Kubernetes docker images in `/kind/images/*.tar`
- placing a file in `/kind/version` containing the Kubernetes semver
See [`docs/node-image`][docs/node-image.md] for more design details.
See [`node-image`][node-image.md] for more design details.
[pkg/build/node_image.go]: ./../../pkg/build/node/node.go
[docs/node-image.md]: ./../../docs/design/node-image.md
[node-image.md]: https://kind.sigs.k8s.io/docs/design/node-image

26
site/content/_index.md
View File

@@ -9,12 +9,12 @@ If you have [go] and [docker] installed `go get sigs.k8s.io/kind && kind create
kind consists of:
- Go [packages][packages] implementing [cluster creation][cluster package], [image build][build package], etc.
- A command line interface ([`kind`][kind cli]) built on these packages.
- Docker [image(s)][images] written to run systemd, Kubernetes, etc.
- [`kubetest`][kubetest] integration also built on these packages (WIP)
- Go [packages][packages] implementing [cluster creation][cluster package], [image build][build package], etc.
- A command line interface ([`kind`][kind cli]) built on these packages.
- Docker [image(s)][images] written to run systemd, Kubernetes, etc.
- [`kubetest`][kubetest] integration also built on these packages (WIP)
kind bootstraps each "node" with [kubeadm][kubeadm]. For more details see [the design documentation][design doc].
kind bootstraps each "node" with [kubeadm][kubeadm]. For more details see [the design documentation][design doc].
**NOTE**: kind is still a work in progress, see the [roadmap].
@@ -59,12 +59,12 @@ See also: the Kubernetes [community page].
## Why kind?
- kind supports multi-node (including HA) clusters
- kind supports building Kubernetes release builds from source
- support for make / bash / docker, bazel, or installing from apt, in addition to pre-published builds.
- kind is written in go, and can be used as a library, has stable releases
- kind supports Windows in addition to MacOS and Linux
- kind is a [CNCF certified conformant Kubernetes installer](https://landscape.cncf.io/selected=kind)
- kind supports multi-node (including HA) clusters
- kind supports building Kubernetes release builds from source
- support for make / bash / docker, bazel, or installing from apt, in addition to pre-published builds.
- kind is written in go, and can be used as a library, has stable releases
- kind supports Windows in addition to MacOS and Linux
- kind is a [CNCF certified conformant Kubernetes installer](https://landscape.cncf.io/selected=kind)
## Alternatives
@@ -98,7 +98,7 @@ Participation in the Kubernetes community is governed by the [Kubernetes Code of
[kubetest]: https://github.com/kubernetes/test-infra/tree/master/kubetest
[kubeadm]: https://kubernetes.io/docs/reference/setup-tools/kubeadm/kubeadm/
[design doc]: ./docs/design/initial
[user guide]: ./docs/user/
[user guide]: ./docs/user/quick-start
[the docs]: ./docs
[SIG-Testing Mailing List]: https://groups.google.com/forum/#!forum/kubernetes-sig-testing
[issue tracker]: https://github.com/kubernetes-sigs/kind/issues
@@ -108,4 +108,4 @@ Participation in the Kubernetes community is governed by the [Kubernetes Code of
[roadmap]: ./docs/roadmap
[install docker]: https://docs.docker.com/install/
[@BenTheElder]: https://github.com/BenTheElder
[@munnerz]: https://github.com/munnerz
[@munnerz]: https://github.com/munnerz