Skip to content

Commit 369f970

Browse files
author
Bob Killen
committed
update readme with install guides
1 parent 89388f1 commit 369f970

File tree

1 file changed

+42
-2
lines changed

1 file changed

+42
-2
lines changed

README.md

+42-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,16 @@ run a single instance of Kubernetes locally using a variety of virtualization en
88

99
Each section assumes an instance of minikube is up and running (`minikube start`).
1010

11-
## Index
11+
Tutorials have been validated against minikube v0.28 running Kubernetes v1.10.
12+
13+
## Installation Guides
14+
* [OSX](#osx-installation-guide)
15+
* [Windows](#windows-installation-guide)
16+
17+
18+
---
19+
20+
## Tutorial Index
1221
* [cli](/cli/README.md) - Covers the basics of using `kubectl` to interact with a Kubernetes cluster.
1322
* [core](/core/README.md) - Tutorial of the core concepts, or building blocks of Kubernetes.
1423
* [workloads](/workloads/README.md) - Walkthrough of the different types of application workloads.
@@ -21,4 +30,35 @@ completed.
2130

2231
---
2332

24-
Tutorials have been validated against minikube v0.26.1 running Kubernetes v1.10.
33+
## OSX Installation Guide
34+
Installation on OSX is done with [Homebrew](https://brew.sh/), an OSX package manager. If you have not installed it
35+
previously, please see their [installation guide](https://brew.sh/) before continuing.
36+
37+
Install `git`, `kubectl`, `minikube` and `virtualbox`.
38+
```
39+
brew install git kubernetes-cli
40+
brew cask install minikube virtualbox
41+
````
42+
43+
---
44+
45+
## Windows Installation Guide
46+
47+
Installation on Windows is done with [chocolatey](https://chocolatey.org/), a Windows Package Manager. If you have not
48+
installed it previously, please see their [installation guide](https://chocolatey.org/install) before continuing.
49+
50+
**NOTE:** The Windows 10 Fall Creators Update enabled HyperV by default on supported hardware. This tutorial has
51+
**NOT** been tested against HyperV, but should theoretically work. If you wish to use HyperV, you may skip disabling
52+
it and the installation of Virtualbox. However minikube must be
53+
[configured and started in a different manner](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#hyperv-driver).
54+
55+
Disable HyperV (will require restart). HyperV unfortunately prevents Virtualbox from functioning properly and must
56+
be disabled.
57+
```
58+
dism.exe /Online /Disable-Feature:Microsoft-Hyper-V
59+
```
60+
61+
Install `git`, `kubectl`, `minikube` and `virtualbox`.
62+
```
63+
choco install git kubernetes-cli minikube virtualbox
64+
```

0 commit comments

Comments
 (0)