Clean up EFLOW VM scripts and add readme (#1958)

Author: noraabiakar

Tools/Eflow/install-hyperv.ps1

@@ -0,0 +1,18 @@
+<# .SYNOPSIS
+    Hyper-V installation Script
+.DESCRIPTION
+    This script automatically installs Hyper-V on a Windows Server VM to allow eflow provisioning.
+    The VM requires a restart after this script is run before eflow can be provisioned.
+.NOTES
+     Author     :
+        Mikhail Chatillon       - chmikhai@microsoft.com
+        Daniele Antonio Maggio  - daniele.maggio@microsoft.com
+        Nora Abi Akar           - noraabiakar@microsoft.com
+#>
+
+# Install Hyper-V
+Install-WindowsFeature -Name Hyper-V
+Install-WindowsFeature -Name Hyper-V-PowerShell
+Enable-WindowsOptionalFeature -Online -FeatureName VirtualMachinePlatform -All -NoRestart
+
+Write-Host "Please reboot to finalize installation."

Tools/Eflow/provision-eflow.ps1

@@ -1,109 +1,85 @@
 <# .SYNOPSIS
     EFLOW Windows Server provisioning Script
 .DESCRIPTION
-    THIS SCRIPT IS NOT RECOMMENDED TO BE USED AS IS, BUT SHOULD BE SEEN AS A COLLECTION OF STEPS TO BE RUN MANUALLY
-    TO GET EFLOW UP AND RUNNING.
-    This script automatically install Edge For Linux On Windows (EFLOW) on a new Windows Server VM
-    The script might trigger a restart and might need to be rerun after a restart
+    This script automatically installs Edge For Linux On Windows (EFLOW) on a new Windows Server VM.
+    This script assumes that the Windows VM has Hyper-V already installed.
+    The script accepts the following parameters:
+    - iotEdgeDeviceConnectionString: (required) the iotedge device connection string.
+    - switchName: (optional) the switch name.
+    - startEflowIpRange: (optional) start of the IP range of eflow.
+    - internalPort: (optional) the internal port of the Net Nat Static Mapping.
+    - externalPort: (optional) the external port of the Net Nat Static Mapping.
 .NOTES
      Author     :
-        Mikhail Chatillon       - chmikhai@microft.com
+        Mikhail Chatillon       - chmikhai@microsoft.com
         Daniele Antonio Maggio  - daniele.maggio@microsoft.com
+        Nora Abi Akar           - noraabiakar@microsoft.com
 #>
 
 param
 (
-    [string]$switchName="EFLOW Switch",
-    [string]$startEflowIpRange=100,
-    [string]$endEflowIpRange=200,
     [string]$iotEdgeDeviceConnectionString,
+    [string]$switchName,
+    [string]$startEflowIpRange=100,
     [int]$internalPort=5000,
     [int]$externalPort=5000
 )
 
-# Enable Windows Features
-if ((Get-WindowsFeature -Name "DHCP").Installed -eq $false)
-{
-    Install-WindowsFeature -Name DHCP -IncludeManagementTools
-}
-if ((Get-WindowsFeature -Name "Hyper-V").Installed -eq $false)
+# Verify dependencies
+if (!$iotEdgeDeviceConnectionString)
 {
-    Install-WindowsFeature -Name Hyper-V
-    Install-WindowsFeature -Name Hyper-V-PowerShell
-    Enable-WindowsOptionalFeature -Online -FeatureName VirtualMachinePlatform -All -NoRestart
-    Write-Host "Restarting the computer in 30 seconds to finish Hyper-V installation"
-    Start-Sleep -Seconds 30
-    Restart-Computer
+    throw "IoT Edge Device Connection String not provided."
 }
-if ((Get-WindowsFeature -Name "DHCP").Installed -eq $false)
+
+if (!$switchName)
 {
-    throw "DHCP not correctly installed."
+    throw "Switch Name not provided."
 }
+
 if ((Get-WindowsFeature -Name "Hyper-V").Installed -eq $false)
 {
     throw "Hyper-V not correctly installed."
 }
 
-# Create the networking
-if(Get-VMSwitch -Name $switchName -ErrorAction SilentlyContinue)
+if(!(Get-VMSwitch -Name $switchName -ErrorAction SilentlyContinue))
 {
-    throw "Switch already existing";
+    throw "Switch $switchName not found";
 }
 
-New-VMSwitch -Name $switchName -SwitchType internal
-Write-Host "Sleeping for 30sec before continuing for propagating the VMSwitch"
-Start-Sleep -Seconds 30
-Write-Host "Finished waiting for propagating the VMSwitch"
+# Create Nat
+Write-Host "Creating Nat"
+
 $netAdapterIfIndex=(Get-NetAdapter -Name "*$switchName*").ifIndex
 $netAdapterIpAddress=Get-NetIPAddress -AddressFamily IPv4  -InterfaceIndex $netAdapterIfIndex
 $netAdapterIp=$netAdapterIpAddress.IPAddress
 $ipAddressFamily=$netAdapterIp.Substring(0, $netAdapterIp.lastIndexOf('.')+1)
-$gwIpCounter=1
-$gwIp=$ipAddressFamily+$gwIpCounter
-
-while(!(get-NetIPAddress -IpAddress $gwIp -ErrorAction SilentlyContinue))
-{
-    $gwIpCounter++
-    if($gwIpCounter>9)
-    {
-        throw "All the IPs in the subnet range 1-9 on $ipAddressFamily were already taken";
-    }
-
-    $gwIp=$ipAddressFamily+$gwIpCounter
-}
-
+$gwIp=$ipAddressFamily+1
 $natIp=$ipAddressFamily+0
-
-New-NetIPAddress -IPAddress $gwIp -PrefixLength 24 -InterfaceIndex $netAdapterIfIndex
-
-if(Get-NetNat -Name "$switchName" -ErrorAction SilentlyContinue)
-{
-    throw "Net Nat with name $switchName already existing";
-}
+$startIp=$ipAddressFamily+$startEflowIpRange
 
 New-NetNat -Name "$switchName" -InternalIPInterfaceAddressPrefix "$natIp/24"
 
-#Install DHCP
-netsh dhcp add securitygroups
-Restart-Service dhcpserver
-$startIp=$ipAddressFamily+$startEflowIpRange
-$endIp=$ipAddressFamily+$endEflowIpRange
-Add-DhcpServerV4Scope -Name "AzureIoTEdgeScope" -StartRange $startIp -EndRange $endIp -SubnetMask 255.255.255.0 -State Active
-Set-DhcpServerV4OptionValue -ScopeID $natIp -Router $gwIp
-Restart-Service dhcpserver
+# Install Eflow
+Write-Host "Installing Eflow"
 
-# install Eflow
 Set-ExecutionPolicy -ExecutionPolicy AllSigned -Force
 $msiPath = $([io.Path]::Combine($env:TEMP, 'AzureIoTEdge.msi'))
 $ProgressPreference = 'SilentlyContinue'
 Invoke-WebRequest "https://aka.ms/AzEflowMSI" -OutFile $msiPath
+
 Start-Process -Wait msiexec -ArgumentList "/i","$([io.Path]::Combine($env:TEMP, 'AzureIoTEdge.msi'))","/qn"
-Deploy-Eflow  -acceptEula 'yes' -acceptOptionalTelemetry 'yes' -vswitchName $switchName -ip4Address $startIp -ip4GatewayAddress $gwIp -vswitchType 'Internal'
-if($iotEdgeDeviceConnectionString){
-    Provision-EflowVm -provisioningType ManualConnectionString -devConnString "$iotEdgeDeviceConnectionString"
-}
+Deploy-Eflow  -acceptEula 'yes' -acceptOptionalTelemetry 'yes' -vswitchName $switchName -ip4Address $startIp -ip4GatewayAddress $gwIp -vswitchType 'Internal' -ip4PrefixLength 24
+Provision-EflowVm -provisioningType ManualConnectionString -devConnString "$iotEdgeDeviceConnectionString"
+
+# Add static mapping
+Write-Host "Creating static mapping"
 
 if(!(Get-NetNatStaticMapping -NatName "$switchName" -ErrorAction SilentlyContinue))
 {
     Add-NetNatStaticMapping -ExternalIPAddress "0.0.0.0/0" -ExternalPort $externalPort -Protocol TCP -InternalIPAddress "$startip" -InternalPort $internalPort -NatName $switchName
 }
+
+# Set DNS server
+Write-Host "Set DNS server"
+
+Set-EflowVmDNSServers -dnsServers 168.63.129.16

Tools/Eflow/readme.md

@@ -0,0 +1,47 @@
+# Eflow on Windows Server VM 
+
+## Install Eflow 
+
+1. Create new Windows Server VM.
+1. Connect to the Windows Server VM.
+1. Install hyper-V
+   ```
+   .\install-hyperv.ps1
+   ```
+1. Restart the VM and reconnect
+1. Create VM Switch 
+   ```
+   $env:switchName = "EFLOW Switch"
+   New-VMSwitch -Name $env:switchName -SwitchType internal
+   ```
+1. Enable Internet Connection Sharing
+   - Open the Network Connections window.
+   - Find the host VM's network that needs to be shared with EFLOW.
+   - Open Properties.
+   - Select the Sharing tab.
+   - Check the box for "Allow other network users to connect through this computer’s Internet connection.”
+1. Provision Eflow
+   ```
+   .\provision-eflow -iotEdgeDeviceConnectionString "HostName=****" -switchName $env:switchName
+   ```
+
+## Verify Eflow installation
+
+1. Connect to the eflow VM
+   ```
+   Connect-EflowVm
+   ```
+
+1. Check the configuration and connection of the VM. 
+   ```
+   sudo iotedge check
+   ```
+
+1. Check that the deployment modules are running on the VM.
+   ```
+   sudo iotedge list
+   ```
+
+
+## Reference
+1. [Create and provision an IoT Edge for Linux on Windows](https://learn.microsoft.com/en-us/azure/iot-edge/how-to-provision-single-device-linux-on-windows-symmetric?view=iotedge-1.4&tabs=azure-portal%2Cpowershell)