Skip to content

Commit

Permalink
Address review comments
Browse files Browse the repository at this point in the history
Signed-off-by: Antonin Bas <antonin.bas@broadcom.com>
  • Loading branch information
antoninbas committed Apr 23, 2024
1 parent 629ce79 commit 7951d10
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 12 deletions.
35 changes: 25 additions & 10 deletions docs/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,13 @@ Node to an existing Kubernetes cluster.
For the detailed design of how antrea-agent works on Windows, please refer to
the [design doc](design/windows-design.md).

**Note: Docker support on Windows Nodes was dropped completely in Antrea v2.0,
making containerd the only supported container runtime. As part of this
change, we renamed the `antrea-windows-containerd.yml` manifest to
`antrea-windows.yml`, and the `antrea-windows-containerd-with-ovs.yml`
manifest to `antrea-windows-with-ovs.yml`. Prior to the Antrea v2.0 release,
the `antrea-windows.yml` manifest was used to support Windows Nodes with Docker.**

### Components that run on Windows

The following components should be configured and run on the Windows Node.
Expand All @@ -43,7 +50,15 @@ The following components should be configured and run on the Windows Node.
* OVS daemons
* antrea-agent

antrea-agent and the OVS daemons can either run as Pods or as Windows services.
antrea-agent and the OVS daemons can either run as Pods (containerized) or as
Windows services, and the following configurations are supported:

| OVS daemons | antrea-agent | Supported | Refer to |
| ---------------- | ---------------- | ----------------- | -------- |
| Containerized | Containerized | Yes (recommended) | [Installation as a Pod](#installation-as-a-pod) |
| Containerized | Windows Service | No | N/A |
| Windows Services | Containerized | Yes | [Installation as a Pod](#installation-as-a-pod) |
| Windows Services | Windows Services | Yes | [Installation as a Service](#installation-as-a-service) |

### Antrea Windows demo

Expand Down Expand Up @@ -77,13 +92,13 @@ Service](#installation-as-a-service) method.

### Installation as a Pod

This installation method requires Antrea 1.10 or higher, and containerd 1.6 or
This installation method requires Antrea v1.10 or higher, and containerd 1.6 or
higher (containerd 1.7 or higher is recommended). It relies on support for
[Windows HostProcess Pods](https://kubernetes.io/docs/tasks/configure-pod-container/create-hostprocess-pod/),
which is generally available starting with K8s 1.26.

Starting with Antrea v1.13, Antrea takes over all the responsibilities of
kube-proxy for Windows nodes by default, and kube-proxy should not be deployed
kube-proxy for Windows Nodes by default, and kube-proxy should not be deployed
on Windows Nodes with Antrea.

#### Download & Configure Antrea for Linux
Expand All @@ -97,7 +112,7 @@ kubectl apply -f https://github.com/antrea-io/antrea/releases/download/<TAG>/ant

#### Add Windows antrea-agent DaemonSet

Starting from Antrea 1.13, you need to manually set the `kubeAPIServerOverride`
Starting from Antrea v1.13, you need to manually set the `kubeAPIServerOverride`
field in the YAML configuration file as the Antrea Proxy `proxyAll` mode is
enabled by default.

Expand All @@ -117,11 +132,11 @@ enabled by default.
For earlier versions of Antrea, you will need to enable `proxyAll` manually.

Starting with Antrea 1.13, you can run both the Antrea Agent and the OVS daemons
on Windows Nodes using a single DaemonSet, by applying the file
`antrea-windows-with-ovs.yml`. This is the recommended installation
method. The following commands download the manifest, set
`kubeAPIServerOverride`, and create the DaemonSet:
Starting with Antrea v1.13, you can run both the Antrea Agent and the OVS
daemons on Windows Nodes using a single DaemonSet, by applying the file
`antrea-windows-with-ovs.yml`. This is the recommended installation method. The
following commands download the manifest, set `kubeAPIServerOverride`, and
create the DaemonSet:

```bash
KUBE_APISERVER=$(kubectl config view -o jsonpath='{.clusters[0].cluster.server}') && \
Expand Down Expand Up @@ -333,7 +348,7 @@ $KubeletKubeconfigPath="C:/etc/kubernetes/kubelet.conf"
```

```powershell
$TAG="v1.15.0"
$TAG="v1.15.1"
$KubernetesVersion="<KubernetesVersion>"
$KubeConfig="<KubeconfigPath>"
$KubeletKubeconfigPath="<KubeletKubeconfigPath>"
Expand Down
4 changes: 2 additions & 2 deletions hack/windows/Prepare-Node.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The node ip used by kubelet
.PARAMETER ContainerRuntime
[DEPRECATED] Container runtime that Kubernetes will use (docker or containerd).
Starting with Antrea v2, only containerd is supported.
Starting with Antrea v2.0, only containerd is supported.
.PARAMETER InstallOVSUserspace
Specifies whether OVS userspace processes are included in the installation. If false, these
Expand Down Expand Up @@ -70,7 +70,7 @@ if ($ContainerRuntime -eq "docker") {
}

if (-not(Test-Path "//./pipe/containerd-containerd")) {
Write-Error "Containerd service was not detected - please install and start Containerd before calling Prepare-Node.ps1"
Write-Error "Containerd service was not detected - please install and start containerd before calling Prepare-Node.ps1"
exit 1
}

Expand Down

0 comments on commit 7951d10

Please sign in to comment.