You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/getting-started-guides/windows/index.md
+67-16
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ The Kubernetes control plane (API Server, Scheduler, Controller Manager, etc) co
17
17
{: .note}
18
18
19
19
## Get Windows Binaries
20
-
We recommend using the release binaries that can be found at [https://github.com/kubernetes/kubernetes/releases/latest](https://github.com/kubernetes/kubernetes/releases/latest). Under the CHANGELOG you can find the Node Binaries link for Windows-amd64, which will include kubeadm, kubectl, kubelet and kube-proxy.
20
+
We recommend using the release binaries that can be found at [https://github.com/kubernetes/kubernetes/releases/latest](https://github.com/kubernetes/kubernetes/releases/latest). Under the CHANGELOG you can find the Node Binaries link for Windows-amd64, which will include kubeadm, kubectl, kubelet and kube-proxy.
21
21
22
22
If you wish to build the code yourself, please refer to detailed build instructions [here](https://docs.microsoft.com/en-us/virtualization/windowscontainers/kubernetes/compiling-kubernetes-binaries).
23
23
@@ -31,7 +31,7 @@ In Kubernetes version 1.9 or later, Windows Server Containers for Kubernetes are
31
31
32
32
## Networking
33
33
There are several supported network configurations with Kubernetes v1.9 on Windows, including both Layer-3 routed and overlay topologies using third-party network plugins.
34
-
34
+
35
35
1.[Upstream L3 Routing](#upstream-l3-routing-topology) - IP routes configured in upstream ToR
36
36
2.[Host-Gateway](#host-gateway-topology) - IP routes configured on each host
37
37
3.[Open vSwitch (OVS) & Open Virtual Network (OVN) with Overlay](#using-ovn-with-ovs) - overlay networks (supports STT and Geneve tunneling types)
@@ -47,7 +47,7 @@ An additional two CNI plugins [win-l2bridge (host-gateway) and win-overlay (vxla
47
47
The above networking approaches are already supported on Linux using a bridge interface, which essentially creates a private network local to the node. Similar to the Windows side, routes to all other pod CIDRs must be created in order to send packets via the "public" NIC.
48
48
49
49
### Windows
50
-
Windows supports the CNI network model and uses plugins to interface with the Windows Host Networking Service (HNS) to configure host networking and policy. At the time of this writing, the only publicly available CNI plugin from Microsoft is built from a private repo and available here [wincni.exe](https://github.com/Microsoft/SDN/blob/master/Kubernetes/windows/cni/wincni.exe). It uses an l2bridge network created through the Windows Host Networking Service (HNS) by an administrator using HNS PowerShell commands on each node as documented in the [Windows Host Setup](#windows-host-setup) section below. Source code for the future CNI plugins will be made available publicly.
50
+
Windows supports the CNI network model and uses plugins to interface with the Windows Host Networking Service (HNS) to configure host networking and policy. At the time of this writing, the only publicly available CNI plugin from Microsoft is built from a private repo and available here [wincni.exe](https://github.com/Microsoft/SDN/blob/master/Kubernetes/windows/cni/wincni.exe). It uses an l2bridge network created through the Windows Host Networking Service (HNS) by an administrator using HNS PowerShell commands on each node as documented in the [Windows Host Setup](#windows-host-setup) section below. Source code for the future CNI plugins will be made available publicly.
51
51
52
52
#### Upstream L3 Routing Topology
53
53
In this topology, networking is achieved using L3 routing with static IP routes configured in an upstream Top of Rack (ToR) switch/router. Each cluster node is connected to the management network with a host IP. Additionally, each node uses a local 'l2bridge' network with a pod CIDR assigned. All pods on a given worker node will be connected to the pod CIDR subnet ('l2bridge' network). In order to enable network communication between pods running on different nodes, the upstream router has static routes configured with pod CIDR prefix => Host IP.
@@ -65,7 +65,7 @@ The following diagram gives a general overview of the architecture and interacti
65
65
66
66
(The above image is from [https://github.com/openvswitch/ovn-kubernetes#overlay-mode-architecture-diagram](https://github.com/openvswitch/ovn-kubernetes#overlay-mode-architecture-diagram))
67
67
68
-
Due to its architecture, OVN has a central component which stores your networking intent in a database. Other components i.e. kube-apiserver, kube-controller-manager, kube-scheduler etc. can be deployed on that central node as well.
68
+
Due to its architecture, OVN has a central component which stores your networking intent in a database. Other components i.e. kube-apiserver, kube-controller-manager, kube-scheduler etc. can be deployed on that central node as well.
69
69
70
70
## Setting up Windows Server Containers on Kubernetes
71
71
To run Windows Server Containers on Kubernetes, you'll need to set up both your host machines and the Kubernetes node components for Windows. Depending on your network topology, routes may need to be set up for pod communication on different nodes.
@@ -76,7 +76,7 @@ To run Windows Server Containers on Kubernetes, you'll need to set up both your
76
76
77
77
##### Linux Host Setup
78
78
79
-
1. Linux hosts should be setup according to their respective distro documentation and the requirements of the Kubernetes version you will be using.
79
+
1. Linux hosts should be setup according to their respective distro documentation and the requirements of the Kubernetes version you will be using.
80
80
2. Configure Linux Master node using steps [here](https://github.com/MicrosoftDocs/Virtualization-Documentation/blob/live/virtualization/windowscontainers/kubernetes/creating-a-linux-master.md)
81
81
3.[Optional] CNI network plugin installed.
82
82
@@ -92,7 +92,7 @@ To run Windows Server Containers on Kubernetes, you'll need to set up both your
92
92
93
93
More detailed instructions can be found [here](https://github.com/MicrosoftDocs/Virtualization-Documentation/blob/live/virtualization/windowscontainers/kubernetes/getting-started-kubernetes-windows.md).
94
94
95
-
**Windows CNI Config Example**
95
+
**Windows CNI Config Example**
96
96
Today, Windows CNI plugin is based on wincni.exe code with the following example, configuration file. This is based on the ToR example diagram shown above, specifying the configuration to apply to Windows node-1. Of special interest is Windows node-1 pod CIDR (10.10.187.64/26) and the associated gateway of cbr0 (10.10.187.66). The exception list is specifying the Service CIDR (11.0.0.0/8), Cluster CIDR (10.10.0.0/16), and Management (or Host) CIDR (10.127.132.128/25).
97
97
98
98
Note: this file assumes that a user previous created 'l2bridge' host networks on each Windows node using `<Verb>-HNSNetwork` cmdlets as shown in the `start-kubelet.ps1` and `start-kubeproxy.ps1` scripts linked above
@@ -229,7 +229,7 @@ Use your preferred method to start Kubernetes cluster on Linux. Please note that
229
229
230
230
## Support for kubeadm join
231
231
232
-
If your cluster has been created by [kubeadm](https://kubernetes.io/docs/setup/independent/create-cluster-kubeadm/),
232
+
If your cluster has been created by [kubeadm](https://kubernetes.io/docs/setup/independent/create-cluster-kubeadm/),
233
233
and your networking is setup correctly using one of the methods listed above (networking is setup outside of kubeadm), you can use kubeadm to add a Windows node to your cluster. At a high level, you first have to initialize the master with kubeadm (Linux), then set up the CNI based networking (outside of kubeadm), and finally start joining Windows or Linux worker nodes to the cluster. For additional documentation and reference material, visit the kubeadm link above.
234
234
235
235
The kubeadm binary can be found at [Kubernetes Releases](https://github.com/kubernetes/kubernetes/releases), inside the node binaries archive. Adding a Windows node is not any different than adding a Linux node:
@@ -290,9 +290,9 @@ Secrets and ConfigMaps can be utilized in Windows Server Containers, but must be
290
290
data:
291
291
username: YWRtaW4=
292
292
password: MWYyZDFlMmU2N2Rm
293
-
293
+
294
294
---
295
-
295
+
296
296
apiVersion: v1
297
297
kind: Pod
298
298
metadata:
@@ -315,7 +315,7 @@ Secrets and ConfigMaps can be utilized in Windows Server Containers, but must be
315
315
nodeSelector:
316
316
beta.kubernetes.io/os: windows
317
317
```
318
-
318
+
319
319
Windows pod with configMap values mapped to environment variables
320
320
321
321
```yaml
@@ -351,14 +351,14 @@ spec:
351
351
nodeSelector:
352
352
beta.kubernetes.io/os: windows
353
353
```
354
-
354
+
355
355
### Volumes
356
356
Some supported Volume Mounts are local, emptyDir, hostPath. One thing to remember is that paths must either be escaped, or use forward slashes, for example `mountPath: "C:\\etc\\foo"` or `mountPath: "C:/etc/foo"`.
357
357
358
358
Persistent Volume Claims are supported for supported volume types.
359
359
360
360
**Examples:**
361
-
361
+
362
362
Windows pod with a hostPath volume
363
363
```yaml
364
364
apiVersion: v1
@@ -380,9 +380,9 @@ Persistent Volume Claims are supported for supported volume types.
380
380
hostPath:
381
381
path: "C:\\etc\\foo"
382
382
```
383
-
383
+
384
384
Windows pod with multiple emptyDir volumes
385
-
385
+
386
386
```yaml
387
387
apiVersion: v1
388
388
kind: Pod
@@ -434,14 +434,65 @@ spec:
434
434
435
435
Windows Stats use a hybrid model: pod and container level stats come from CRI (via dockershim), while node level stats come from the "winstats" package that exports cadvisor like data structures using windows specific perf counters from the node.
436
436
437
+
### Container Resources
438
+
439
+
Container resources (CPU and memory) could be set now for windows containers in v1.10.
440
+
441
+
```yaml
442
+
apiVersion: apps/v1
443
+
kind: Deployment
444
+
metadata:
445
+
name: iis
446
+
spec:
447
+
replicas: 3
448
+
template:
449
+
metadata:
450
+
labels:
451
+
app: iis
452
+
spec:
453
+
containers:
454
+
- name: iis
455
+
image: microsoft/iis
456
+
resources:
457
+
limits:
458
+
memory: "128Mi"
459
+
cpu: 2
460
+
ports:
461
+
- containerPort: 80
462
+
```
463
+
464
+
### Hyper-V Containers
465
+
466
+
Hyper-V containers are supported as experimental in v1.10. To create a Hyper-V container, kubelet should be started with feature gates `HyperVContainer=true` and Pod should include annotation `experimental.windows.kubernetes.io/isolation-type=hyperv`.
## Known Limitations for Windows Server Containers with v1.9
438
490
Some of these limitations will be addressed by the community in future releases of Kubernetes
439
491
- Shared network namespace (compartment) with multiple Windows Server containers (shared kernel) per pod is only supported on Windows Server 1709 or later
440
-
- Using Secrets and ConfigMaps as volume mounts is not supported
492
+
- Using Secrets and ConfigMaps as volume mounts is not supported
441
493
- Mount propagation is not supported on Windows
442
494
- The StatefulSet functionality for stateful applications is not supported
443
495
- Horizontal Pod Autoscaling for Windows Server Container pods has not been verified to work end-to-end
444
-
- Hyper-V isolated containers are not supported.
445
496
- Windows container OS must match the Host OS. If it does not, the pod will get stuck in a crash loop.
446
497
- Under the networking models of L3 or Host GW, Kubernetes Services are inaccessible to Windows nodes due to a Windows issue. This is not an issue if using OVN/OVS for networking.
447
498
- Windows kubelet.exe may fail to start when running on Windows Server under VMware Fusion [issue 57110](https://github.com/kubernetes/kubernetes/pull/57124)
0 commit comments