Skip to content
Permalink
Browse files

docs: Add download steps and D4W settings on Windows

  • Loading branch information...
PatrickLang committed Jul 10, 2019
1 parent 1333f66 commit e2fbefeef1dad0296a3eb257b5f9e8238cdcd7ed
Binary file not shown.
Binary file not shown.
@@ -126,9 +126,11 @@ equal to Docker 18.09.1.
## Failure to build node image
The know case in which building kind's node image may fail is due to
Docker on Mac running out of memory, see [kind#229][kind#229].
Building kind's node image may fail due to running out of memory on Docker for Mac or Docker for Windows.
See [kind#229][kind#229].
If you see something like this:
```
cmd/kube-scheduler
cmd/kube-proxy
@@ -165,7 +167,7 @@ Global Flags:
error building node image: failed to build kubernetes: failed to build images: exit status 2
```
Then you may try increasing the resource limits for the Docker engine on Mac.
Then you may try increasing the resource limits for the Docker engine on Mac or Windows.
It is recommended that you allocate at least 8GB of RAM to build Kubernetes.
@@ -176,8 +178,9 @@ Open the **Preferences** menu.
Go to the **Advanced** settings page, and change the settings there, see
[changing Docker's resource limits][Docker resource lims].
<img width="400px" src="/docs/user/images/docker-pref-build.png"/>
<img width="400px" src="/docs/user/images/docker-pref-build.png" alt="Setting 8Gb of memory in Docker for Mac" />
<img width="400px" src="/docs/user/images/docker-pref-build-win.png" alt="Setting 8Gb of memory in Docker for Windows" />
## Failing to properly start cluster
This issue is similar to a
@@ -28,14 +28,25 @@ Without installing go, kind can be built reproducibly with docker using `make bu
Stable binaries are also available on the [releases] page. Stable releases are
generally recommended for CI usage in particular.
To install, download the binary for your platform from "Assets" and place this
into your `$PATH`. E.G. for macOS:
into your `$PATH`.

```
E.G. for macOS:

```bash
curl -Lo ./kind-darwin-amd64 https://github.com/kubernetes-sigs/kind/releases/download/v0.4.0/kind-darwin-amd64
chmod +x ./kind-darwin-amd64
mv ./kind-darwin-amd64 /some-dir-in-your-PATH/kind
```


E.G. for Windows:

```powershell
curl.exe -Lo kind-windows-amd64.exe https://github.com/kubernetes-sigs/kind/releases/download/v0.4.0/kind-windows-amd64
Move-Item .\kind-windows-amd64.exe c:\some-dir-in-your-PATH\kind.exe
```


## Creating a Cluster

Creating a Kubernetes cluster is as simple as `kind create cluster`.
@@ -168,16 +179,29 @@ If you previously changed the name and tag of the base image, you can use here
the flag `--base-image` to specify the name and tag you used.

**Note**: If you are running kind on MacOS or Windows then it is recommended
that you have at least 4GB of RAM dedicated to the virtual machine (VM) running
that you have at least 8GB of RAM dedicated to the virtual machine (VM) running
the Docker engine otherwise Building Kubernetes may fail.

To change the resource limits for the Docker engine on Mac, you'll need to open the
To change the resource limits for the Docker on Mac, you'll need to open the
**Preferences** menu.
<img src="/docs/user/images/docker-pref-1.png"/>

Now, go to the **Advanced** settings page, and change the
settings there, see [changing Docker's resource limits][Docker resource lims].
<img src="/docs/user/images/docker-pref-2.png"/>
<img src="/docs/user/images/docker-pref-2.png" alt="Setting 8Gb of memory in Docker for Mac" />


To change the resource limits for the Docker on Windows, you'll need to right-click the Moby
icon on the taskbar, and choose "Settings". If you see "Switch to Linux Containers", then you'll need
to do that first before opening "Settings"

<img src="/docs/user/images/docker-pref-1-win.png"/>

Now, go to the **Advanced** settings page, and change the
settings there, see [changing Docker's resource limits][Docker resource lims].

<img src="/docs/user/images/docker-pref-build-win.png" alt="Setting 8Gb of memory in Docker for Windows" />


You may also try removing any unused data left by the Docker engine - e.g.,
`docker system prune`.

0 comments on commit e2fbefe

Please sign in to comment.
You can’t perform that action at this time.