Add support for Windows OVS Containerisation in Install-OVS script

For #4952 Signed-off-by: Naman Agarwal <[email protected]>
antrea-io · Jun 5, 2023 · 1bf9a05 · 1bf9a05
1 parent 5562b29
commit 1bf9a05
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 4 deletions.
diff --git a/docs/windows.md b/docs/windows.md
@@ -23,6 +23,7 @@ The following components should be configured and run on the Windows Node.
 
 antrea-agent and kube-proxy run as processes on host and are managed by
 management Pods. It is recommended to run OVS daemons as Windows services.
+We also support running OVS processes inside container.
 If you don't want to run antrea-agent and kube-proxy from the management Pods
 Antrea also provides scripts which help install and run these two components
 directly without Pod, please see [Manually run kube-proxy and antrea-agent on Windows worker Nodes](#Manually-run-kube-proxy-and-antrea-agent-on-Windows-worker-Nodes)
@@ -302,6 +303,12 @@ get-service ovsdb-server
 get-service ovs-vswitchd
 ```
 
+If you want to containerise OVS for containerd runtime, use the `ContaineriseOVS` parameter as true.
+
+```powershell
+.\Install-OVS.ps1 -ContaineriseOVS $true 
+```
+
 #### 2. Disable Windows Firewall
 
 ```powershell

diff --git a/hack/windows/Install-OVS.ps1 b/hack/windows/Install-OVS.ps1
@@ -21,14 +21,18 @@
   .PARAMETER ImportCertificate
   Specifies if a certificate file is needed for OVS package. If true, certificate
   will be retrieved from OVSExt.sys and a package.cer file will be generated.
+
+  .PARAMETER ContaineriseOVS
+  Specifies whether user wants to run ovs inside container.
 #>
 Param(
     [parameter(Mandatory = $false)] [string] $DownloadDir,
     [parameter(Mandatory = $false)] [string] $DownloadURL,
     [parameter(Mandatory = $false)] [string] $OVSInstallDir = "C:\openvswitch",
     [parameter(Mandatory = $false)] [bool] $CheckFileHash = $true,
     [parameter(Mandatory = $false)] [string] $LocalFile,
-    [parameter(Mandatory = $false)] [bool] $ImportCertificate = $true
+    [parameter(Mandatory = $false)] [bool] $ImportCertificate = $true,
+    [parameter(Mandatory = $false)] [bool] $ContaineriseOVS = $false 
 )
 
 $ErrorActionPreference = "Stop"
@@ -251,6 +255,13 @@ function ConfigOVS() {
     ovs-vsctl --no-wait set Open_vSwitch . ovs_version=$OVS_VERSION
 }
 
+if ($ContaineriseOVS -eq $true) {
+    if(!(Get-Process containerd )){
+        Write-error "Containerd runtime not found. Containerd runtime is required for OVS Containerisation."
+        exit 1
+    }
+}
+
 Log "Installation log location: $InstallLog"
 
 CheckIfOVSInstalled
@@ -259,8 +270,10 @@ DownloadOVS
 
 InstallOVS
 
-InstallDependency
+if ($ContaineriseOVS -eq $false) {
+    InstallDependency
 
-ConfigOVS
+    ConfigOVS
+} 
 
 Log "OVS Installation Complete!"
diff --git a/hack/windows/Prepare-Node.ps1 b/hack/windows/Prepare-Node.ps1
@@ -22,6 +22,9 @@ Install OVS
 .PARAMETER NodeIP
 The node ip used by kubelet
 
+.PARAMETER OVSContainerisation
+To determine whether ovs daemons are required to run inside container or on windows host.
+
 .EXAMPLE
 PS> .\Prepare-Node.ps1 -KubernetesVersion v1.18.0 -InstallOVS -NodeIP 192.168.1.10
 
@@ -32,6 +35,7 @@ Param(
     [parameter(Mandatory = $true, HelpMessage="Node IP")] [string] $NodeIP,
     [parameter(Mandatory = $false)] [switch] $InstallOVS = $false,
     [parameter(Mandatory = $false, HelpMessage="Kubernetes download")] [string] $KubernetesURL="dl.k8s.io"
+    [parameter(Mandatory = $false)] [bool] $OVSContainerisation = $false 
 )
 $ErrorActionPreference = 'Stop'
 
@@ -127,5 +131,9 @@ New-NetFirewallRule -Name kubelet -DisplayName 'kubelet' -Enabled True -Directio
 
 if ($InstallOVS) {
     Write-Host "Installing OVS"
-    & .\Install-OVS.ps1
+    if ($OVSContainerisation){
+        & .\Install-OVS.ps1 -ContaineriseOVS $true
+    } else {
+        & .\Install-OVS.ps1  
+    }
 }