Commit Graph

129 Commits

Author SHA1 Message Date
Kay Yan
974fa25b0d update docs for nerdctl support
Co-authored-by: Sean McGinnis <sean.mcginnis@gmail.com>
Signed-off-by: Kay Yan <kay.yan@daocloud.io>
2024-02-28 04:44:16 +00:00
Benjamin Elder
985b60afb5 fix lingering go get in quick start 2023-05-19 13:59:11 -07:00
Benjamin Elder
ff32c745b3 simplify install docs now that go 1.16+ is required.
go 1.16 has support for "go install" so we can drop "go get"
2023-05-16 22:05:08 -07:00
m-Bilal
9b24145088 add example to build image by providing location to kubernetes source 2023-03-26 13:10:59 +05:30
Rewanth Tammana
8d258b546a Updates quick installation linux command 2022-08-04 20:59:36 +04:00
Rewanth Tammana
7110140aa9 Updates linux default installation 2022-08-03 15:25:45 +04:00
Benjamin Elder
f80d692928 handle M1 vs intel macs in install directions 2022-05-10 18:30:07 -07:00
Sean McGinnis
c085ec14f4 Add note to quick start about idempotent deletes
While reviewing kind issues, I noticed there seems to be a regularly
recurring problem with users expecting `kind delete cluster foo` to
fail if there is not a cluster named `foo` present.

We intentionally do not fail in this case. The delete command is
idempotent, and should be able to be run repeatedly without erroring.
This is very useful in clean up scripts, and many users rely on this
behavior.

It also makes things somewhat declarative in that you are saying "I
don't want a cluster named foo", and `kind` helpfully confirms that
there is no cluster named "foo".

To try to avoid some of these repeated issues being filed, this adds a
note to the quick start docs in the "Deleting a Cluster" section to
point out that this is the expected behavior. This also helps new users
to know that they can depend on this behavior if they are scripting
things with kind.

Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
2022-02-24 15:54:37 -06:00
Hu Shuai
1c729cc907 Fix a small typo
Signed-off-by: Hu Shuai <hus.fnst@fujitsu.com>
2021-11-18 16:51:02 +08:00
Benjamin Elder
fe36fad651 re-organize install guide and add more details 2021-11-15 14:12:30 -08:00
Conrad Taylor
60c395b181 Fix unrelated edits caused by auto-formatting. 2021-05-18 22:45:06 -07:00
Benjamin Elder
09836cf089 cover upstream build requirements 2021-05-18 12:49:13 -07:00
Jintao Zhang
30195c1ab3 drop bazel
Signed-off-by: Jintao Zhang <zhangjintao9020@gmail.com>
2021-04-12 09:37:36 +08:00
Antonio Ojea
2a910638a1 reorganize IPFamily docs 2021-04-01 20:32:15 +02:00
Antonio Ojea
114dd68d5f fix dualstack docs 2021-04-01 12:21:20 +02:00
Antonio Ojea
ec617af085 Add dual stack support: Docs
Fix dual docs
2021-03-26 11:14:39 +01:00
Benjamin Elder
b30f419467 update references to kind master branch -> main branch 2021-03-16 16:27:48 -07:00
Benjamin Elder
bcfa8dedde Merge pull request #2125 from rudeigerc/shortcode-version
Add a shortcode for inserting the stable version
2021-03-16 12:12:59 -07:00
Benjamin Elder
d5111f840c fix minor formatting nit 2021-03-16 10:49:37 -07:00
Yashvardhan Kukreja
d3327a3296 Added: support for providing multiple docker-images via multiple arguments to 'kind load docker-image ' command 2021-03-16 22:02:15 +05:30
rudeigerc
bb66a15100 Add a shortcode for inserting the stable version
Signed-off-by: rudeigerc <rudeigerc@gmail.com>
2021-03-16 23:55:25 +08:00
Akihito INOH
a952386aa3 Fix 404 link about relative path
This commit fixes some 404 links on kind website.

e.g.
Link to `Ingress Guide` at description on `/docs/user/loadbalancer`.

If you access to the page `https://kind.sigs.k8s.io/docs/user/loadbalancer/`,
got page OK and `Ingress Guide` link is OK too.
But access to `https://kind.sigs.k8s.io/docs/user/loadbalancer` w/o last slash,
got page OK but click `Ingress Guide` link got 404.

The cause is that part of links use relative path link style like `./..`.
This commit changes link of `./..` with `/docs/user` style.
2021-03-08 08:17:25 +09:00
Matthias Wessendorf
3a47ce3d82 📓 updating the user manual too
Signed-off-by: Matthias Wessendorf <mwessend@redhat.com>
2021-01-29 08:47:58 +01:00
M Carlise
4cb45db3f7 docs: loadbalancer userguide
documents an example of using metallb in KinD to get LoadBalancer
services past pending EXTERNAL-IP.
2021-01-19 21:11:14 -05:00
Benjamin Elder
b443fd33d2 refer to release notes for node images 2020-12-03 13:24:14 -08:00
Benjamin Elder
3aca034280 fix tiny docs bugs 2020-12-03 10:53:42 -08:00
Benjamin Elder
751678318f move base image building out of quick-start 2020-12-03 01:08:34 -08:00
Benjamin Elder
13e7edbb79 normalize NOTEs 2020-12-02 19:20:53 -08:00
Benjamin Elder
95440514d9 fixup some styling, add dedicated descriptions, add dockershim notice
sorry for the big commit, I've been hacking to get things looking good and out quickly with all the dockershim concern out there 🤷‍♂️
2020-12-02 16:54:13 -08:00
Gonéri Le Bouder
14ec763f3f address two minor errors in the quick-start.md 2020-11-19 09:07:38 -05:00
Andreas Sommer
bcae4c13b9 Add TOC to configuration and quick start docs 2020-11-10 12:58:10 +01:00
Wei Huang
caad3667d5 Fix indents of page quick-start.md 2020-09-25 15:57:15 -07:00
Benjamin Elder
3dedc7ffe6 update install docs for v0.9.0 2020-09-14 17:44:41 -07:00
Benjamin Elder
89c84494e6 add a note about go get inside go module projects 2020-08-19 10:51:47 -07:00
jay vyas
cb40e20600 Update quick-start.md 2020-07-15 09:56:46 -04:00
jay vyas
b123348fbf Fix Mac OS X url 2020-07-12 14:18:06 -04:00
Aleks Volochnev
04e1f0ff1d Up version to 0.8.1 at quick-start.md 2020-05-15 17:47:02 +02:00
Yash Bhutwala
54ec2bd2cc fix spacing 2020-05-12 11:04:18 -04:00
Yash Bhutwala
e1b1dac4cf fix featureGate docs to use the new top level field in Cluster config 2020-05-10 11:49:38 -04:00
Benjamin Elder
a6b207c54e s/v0.7.0/v0.8.0 in docs 2020-04-30 20:21:58 -07:00
Benjamin Elder
b892a9a6ad drop stale note 2020-04-30 13:52:00 -07:00
Benjamin Elder
fd285ef380 improve documentation 2020-04-29 23:48:30 -07:00
Antonio Ojea
c8023347db update ipv6 docs 2020-04-29 18:42:10 +02:00
Benjamin Elder
3783817a78 use shiny new download URLs 2020-04-16 22:17:29 -07:00
Benjamin Elder
042ea991dd Merge pull request #1391 from JamesLaverack/list-images-docs
Add docs note on how to list loaded images
2020-04-16 17:26:57 -07:00
Narendra Kangralkar
cd2dec30d9 Fix typo 2020-03-22 14:51:30 +05:30
James Laverack
1fc9fad5b6 Add docs note on how to list loaded images
This can aid debugging, and help to understand the state of the cluster.

This delightful one-liner courtesy of github.com/jlaswell
2020-03-10 14:45:28 +00:00
Jintao Zhang
441c5ca113 docs: remove kind build base-image
xref: https://github.com/kubernetes-sigs/kind/pull/1376

Signed-off-by: Jintao Zhang <zhangjintao9020@gmail.com>
2020-02-29 16:29:12 +08:00
Benjamin Elder
72dd928437 remove stray this 2020-02-28 14:25:01 -08:00
Benjamin Elder
7fa371d05b less words 2020-02-28 14:21:26 -08:00