Skip to content

Commit 9ea060f

Browse files
authored
Update README.md
1 parent 7a83e93 commit 9ea060f

File tree

1 file changed

+17
-26
lines changed

1 file changed

+17
-26
lines changed

README.md

Lines changed: 17 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,12 @@
1-
# KubernetesOnWindows
1+
# Welcome to the sig-windows Development Environment !
22

33
This is a fully batteries-included development for Windows on Kubernetes, including:
44
- Vagrant file for launching a two-node cluster
55
- the latest containerd
66
- NetworkPolicy support for Windows and Linux provided by [Antrea](https://antrea.io)
77
- Windows binaries for kube-proxy.exe and kubelet.exe that are fully built from source (K8s main branch)
8-
9-
Soon to be integrated into kubernetes-sigs/windows-dev-environment!
10-
11-
We welcome contributions. We'd especially love to see:
12-
- More CNI providers (calico, cillium, ...)
13-
- More Container Runtime ideas
14-
- More vagrant infrastructures (Vsphere, VMWare Fusion, EC2, GCE, and so on)
15-
- E2Es or scripts which exercise privileged containers or LDAP / AD
16-
- CSI or other storage/volume add-ons
17-
- other ideas!
18-
8+
- kubeadm installation that can put the bleeding edge linux control plane in place, so you can test new featuers like priveliged containers
9+
1910
# Goal
2011

2112
Our goal is to make Windows ridiculously easy to contribute to, play with, and learn about for anyone interested
@@ -26,7 +17,7 @@ viable alternative to Linux thanks to the recent introduction of Windows HostPro
2617

2718
- vagrant
2819
- vagrant reload plugin
29-
- some vagrant provider (we only have virtualbox automated here, but these recipes have been used with others, like HyperV)
20+
- some vagrant provider (we only have virtualbox automated here, but these recipes have been used with others, like HyperV and Fusion).
3021

3122
# Lets run it!
3223

@@ -36,25 +27,21 @@ Ok let's get started...
3627

3728
For the happy path, just:
3829

30+
0) Start docker so that you can build k8s from source as needed.
3931
1) Install vagrant, and then vagrant-reload
4032
```
4133
vagrant plugin install vagrant-reload
4234
```
43-
44-
2) Modify cpu/memory. We advise 8GB RAM for Windows. If your system has less than 16GB RAM, adjust the `Vagrantfile`:
45-
```
46-
winw1.vm.provider :virtualbox do |vb|
47-
vb.memory = 4096
48-
```
49-
change the `4096` to `2048`.
50-
35+
2) Modify cpu/memory in the variables.yml file. We recommend 4 cores 8G+ for your windows node if you can spare it, and 2 cores 8G for your linux node as well.
36+
5137
## 2) Run it!
5238

5339
There are two use cases for these Windows K8s dev environments: Quick testing, and testing K8s from source.
5440

55-
## 3) Testing from source? make
41+
## 3) Testing from source? make all
5642

57-
To test from source, run `make all`. This will
43+
To test from source, run `vagrant destroy --force ; make all`. This will
44+
- destroy your existing dev environment
5845
- clone down K8s from GitHub. If you have the k/k repo locally, you can `make path=path_to_k/k all`
5946
- compile the K8s proxy and kubelet
6047
- inject them into the Vagrant Windows environment at the C:/k/bin/ location
@@ -76,6 +63,8 @@ AND THAT'S IT! Your machines should come up in a few minutes...
7663
## IMPORTANT
7764
Do not log into the VMs until the provisioning is done. That is especially true for Windows because it will prevent the reboots.
7865

66+
## Other notes
67+
7968
If you still have an old instance of these VMs running for the same dir:
8069
```
8170
vagrant destroy -f && vagrant up
@@ -114,7 +103,9 @@ To run a *command* on the Windows boxes without actually using the UI, you can u
114103
vagrant winrm winw1 --shell=powershell --command="ls"
115104
```
116105

117-
## Where did I steal all the stuff?
106+
## Where we derived these recipes from
118107

119-
This guide is based on [this very nice Vagrantfile](https://gist.github.com/danielepolencic/ef4ddb763fd9a18bf2f1eaaa2e337544) and this very good [guide on how to install Kubernetes on Ubuntu Focal (20.04)](https://github.com/mialeevs/kubernetes_installation).
120-
The Windows part is informed by this [guide on how to install Docker on Win Server 2019](https://www.hostafrica.co.za/blog/new-technologies/how-to-install-docker-on-linux-and-windows/#win), [this guide on adding Windows nodes](https://kubernetes.io/docs/tasks/administer-cluster/kubeadm/adding-windows-nodes/), and [this guide](https://www.hostafrica.co.za/blog/new-technologies/install-kubernetes-cluster-windows-server-worker-nodes/) on how to install Kubernetes on Win Server 2019.
108+
- This guide is based on [this very nice Vagrantfile](https://gist.github.com/danielepolencic/ef4ddb763fd9a18bf2f1eaaa2e337544)
109+
- this very good [guide on how to install Kubernetes on Ubuntu Focal (20.04)](https://github.com/mialeevs/kubernetes_installation).
110+
- The Windows part is informed by this [guide on how to install Docker on Win Server 2019](https://www.hostafrica.co.za/blog/new-technologies/how-to-install-docker-on-linux-and-windows/#win), [this guide on adding Windows nodes](https://kubernetes.io/docs/tasks/administer-cluster/kubeadm/adding-windows-nodes/), and [this guide](https://www.hostafrica.co.za/blog/new-technologies/install-kubernetes-cluster-windows-server-worker-nodes/) on how to install Kubernetes on Win Server 2019.
111+
- We've also borrowed ideas from cluster api, kubeadm, and the antrea project too bootstrap how we manage CNI and containerd support.

0 commit comments

Comments
 (0)