From 7e3f73d1c0e98bab1410d222c31aa185f57416c5 Mon Sep 17 00:00:00 2001 From: Purushottam Ray Date: Wed, 18 Aug 2021 15:10:05 +0530 Subject: [PATCH 1/5] Changed the doc --- .gitignore | 2 + fn/develop/running-fn-client-windows.md | 84 +++++++++++++------------ 2 files changed, 45 insertions(+), 41 deletions(-) diff --git a/.gitignore b/.gitignore index 2f7896d..ea76a74 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,3 @@ target/ +.idea/ + diff --git a/fn/develop/running-fn-client-windows.md b/fn/develop/running-fn-client-windows.md index f841639..68ec1b7 100644 --- a/fn/develop/running-fn-client-windows.md +++ b/fn/develop/running-fn-client-windows.md @@ -1,13 +1,13 @@ # How-to: Run Fn client on Windows and connect to a remote Fn server -You can run the Fn client on Windows 10 Professional and connect to a remote Fn server. This document provides the steps to make that happen. +You can run the Fn client on Windows 10 and connect to a remote Fn server. This document provides the steps to make that happen. ## Fn System Requirements -To install Fn on Windows, you need the following software: +To install Fn on Windows, you need the following software/hardware: -* Windows 10 Professional 64 bit Enterprise, or Education (Build 15063 or later) - * This is a requirement for Docker -* Docker Desktop for Windows (2.1.0.1 +) -* Microsoft Hyper-V and Containers support installed +* Windows 10 64-bit: Pro 2004 (build 19041) or higher, or Enterprise or Education 1909 (build 18363) or higher. + * This is a requirement for Docker. +* Docker Desktop for Windows (3.3.3 +) +* Microsoft Hyper-V and Containers support installed Links to the get all this installed are provided below. @@ -18,10 +18,27 @@ Fn client requires Docker Desktop for Windows to run. Here are some links to for ### Docker System Requirements To install Docker, you have to have all of the following. -* Virtualization enabled in your laptop's BIOS. See the documentation from your manufacturer for this step. -* Windows 10 64-bit: Pro, Enterprise, or Education (Build 15063 or later). +* Windows 10 64-bit: Pro 2004 (build 19041) or higher, or Enterprise or Education 1909 (build 18363) or higher. * Enable the Hyper-V and Containers features for Windows 10 Professional. +* The following hardware prerequisites are required to successfully run Client Hyper-V on Windows 10 + - 64 bit processor with Second Level Address Translation (SLAT) + - 4GB system RAM + - BIOS-level hardware virtualisation support must be enabled in the BIOS settings. See the documentation from your manufacturer for this step. For more information, see Virtualization: +**Note:** +Above system need can change with newer docker desktop versions. More on requirements, check here: .You can also download the script:<> locally and execute in below way to see the current system state. +- Open PowerShell as Administrator(```click Start > Windows PowerShell > Run as Administrator```) +- Execute command ```Get-ExecutionPolicy``` and note down the outcome as it is needed in subsequent steps. +- Execute command ```Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy Unrestricted -Force;``` +- Execute command ```<>\fn_installer.ps1 "get-system-state"``` + + - ```<>``` is fully-qualified path of downloaded script. For example: ```C:\Users\<>\Downloads\fn_install\``` + + - Outcome of above command will show you system state. +- Once done with script execution, execute command ```Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy <> -Force;``` + + - ```<>``` this is same as the outcome you noted down after execution of command ```Get-ExecutionPolicy``` above. + - close the opened ```Powershell``` ### Install Docker These are the steps to install Docker. @@ -29,42 +46,27 @@ These are the steps to install Docker. 2. Enable Hyper-V and Containers features for Windows 10. See: 3. Perform the Docker install. See: . 4. Setup a [DockerHub account](https://hub.docker.com/signup). This is required to store Docker images on the net. - + + With Docker installed, you are ready to install the Fn client. ## Install Fn Client -There are three ways to install the Fn client on Windows. - -### (1) Windows 10 Quick and Dirty -* Go to: -* Download the latest `fn.exe`. -* Copy the file into the `C:\Windows` directory. - -The Fn client is now in your `PATH` and ready to go. - -### (2) Windows 10 without Access to System Directories -If your IT department has locked you out of your system directories, then there are more steps for you to do. - -1. Go to: -2. Download the latest `fn.exe`. -3. Create a directory for Fn. - 1. `cd c:\` - 2. `mkdir fn` -4. Copy `fn.exe` to that directory. -5. Add your new directory to the path. - 1. **Right-click** the **Start menu**. - 2. Select **System**. - 3. Scroll down in the main window and **Click** on the link **System Info**. - 4. In the System dialog box, click **Advanced system settings**. - 5. On the Advanced tab of the System Properties dialog box, click **Environment Variables**. - 6. In the System Variables box of the Environment Variables dialog box, scroll to **Path** and select it. - 7. **Click** the **lower of the two Edit buttons** in the dialog box. - 8. **Click** the **New** button. - 9. Enter in your directory name `c:\fn`. - 10. **Click** the **OK** button. - 11. Click **OK** in three successive dialog boxes, and the System dialog box closes. - -Now when you open a Windows **Command Prompt**, the Fn client should be in the path. +Follow the steps below to install the Fn client on Windows. + +- Download the script:<> locally and execute in below way to see the current system state. +- Open PowerShell as Administrator(```click Start > Windows PowerShell > Run as Administrator```) +- Execute command ```Get-ExecutionPolicy``` and note down the outcome as it is needed in subsequent steps. +- Execute command ```Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy Unrestricted -Force;``` +- Execute command ```<>\fn_installer.ps1 "fn-client-install"``` + + - ```<>``` is fully-qualified path of downloaded script. For example: ```C:\Users\<>\Downloads\fn_install\``` + +- Once done with script execution, execute command ```Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy <> -Force;``` + + - ```<>``` this is same as the outcome you noted down after execution of command ```Get-ExecutionPolicy``` above. + - close the opened ```Powershell``` + +Now when you open a Windows **Command Prompt**, and execute command ```fn version```. ### (3) Install the Linux Subsystem for Windows The Linux subsystem for Windows is now a standard feature of Windows as of build 16215. The Linux Fn client runs fine in the subsystem. To install the Fn client do the following: From d8bb0f6e3d735edd8d39bb0f00202cf701d48ed6 Mon Sep 17 00:00:00 2001 From: Purushottam Ray Date: Wed, 18 Aug 2021 18:48:35 +0530 Subject: [PATCH 2/5] Changed the doc --- fn/develop/running-fn-client-windows.md | 100 ++++++++++++++++++------ 1 file changed, 76 insertions(+), 24 deletions(-) diff --git a/fn/develop/running-fn-client-windows.md b/fn/develop/running-fn-client-windows.md index 68ec1b7..1733095 100644 --- a/fn/develop/running-fn-client-windows.md +++ b/fn/develop/running-fn-client-windows.md @@ -18,27 +18,58 @@ Fn client requires Docker Desktop for Windows to run. Here are some links to for ### Docker System Requirements To install Docker, you have to have all of the following. -* Windows 10 64-bit: Pro 2004 (build 19041) or higher, or Enterprise or Education 1909 (build 18363) or higher. -* Enable the Hyper-V and Containers features for Windows 10 Professional. -* The following hardware prerequisites are required to successfully run Client Hyper-V on Windows 10 +1. Windows 10 64-bit: Pro 2004 (build 19041) or higher, or Enterprise or Education 1909 (build 18363) or higher. +2. The following hardware prerequisites are required to successfully run Client Hyper-V on Windows 10 - 64 bit processor with Second Level Address Translation (SLAT) - 4GB system RAM - BIOS-level hardware virtualisation support must be enabled in the BIOS settings. See the documentation from your manufacturer for this step. For more information, see Virtualization: +3. Enabled ```Hyper-V and Containers features```for Windows 10. + +**Note:** *Above system need can change with newer docker desktop versions.More on requirements, check: .* + + *You can also download the script:<> locally and execute in below way to see the current system state and see whether it is meeting the above need, otherwise Docker desktop will not work.* +- Open PowerShell as Administrator + ``` + click Start > Windows PowerShell > Run as Administrator + ``` +- Execute command in opened PowerShell and note down the outcome as it is needed in subsequent steps. + ``` + Get-ExecutionPolicy + ``` +- Execute command in opened PowerShell + ``` + Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy Unrestricted -Force; + ``` + +- Execute command in opened PowerShell. Outcome of command will show your system state. + ``` + <>\fn_installer.ps1 "get-system-state" + ``` + + ***<>*** is fully-qualified path of downloaded script. *For example:* + ```C:\Users\<>\Downloads\fn_install\``` + -**Note:** -Above system need can change with newer docker desktop versions. More on requirements, check here: .You can also download the script:<> locally and execute in below way to see the current system state. -- Open PowerShell as Administrator(```click Start > Windows PowerShell > Run as Administrator```) -- Execute command ```Get-ExecutionPolicy``` and note down the outcome as it is needed in subsequent steps. -- Execute command ```Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy Unrestricted -Force;``` -- Execute command ```<>\fn_installer.ps1 "get-system-state"``` +- If just above step is showing that ```Hyper-V``` is not enabled then you can run command in opened PowerShell. This will enable the ```Hyper-V```. + This step may result in system restart, please do follow the steps below post restart. - - ```<>``` is fully-qualified path of downloaded script. For example: ```C:\Users\<>\Downloads\fn_install\``` + ``` + <>\fn_installer.ps1 "enable-hyperviser" + ``` + ***<>*** is fully-qualified path of downloaded script. *For example:* + ```C:\Users\<>\Downloads\fn_install\``` - - Outcome of above command will show you system state. -- Once done with script execution, execute command ```Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy <> -Force;``` - - ```<>``` this is same as the outcome you noted down after execution of command ```Get-ExecutionPolicy``` above. - - close the opened ```Powershell``` +- Once done with above steps, execute command in opened PowerShell + ``` + Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy <> -Force; + ``` + + ***<>*** this is same as the outcome you noted down after execution of command ```Get-ExecutionPolicy``` above. + + +- close the opened Powershell + ### Install Docker These are the steps to install Docker. @@ -53,20 +84,41 @@ With Docker installed, you are ready to install the Fn client. ## Install Fn Client Follow the steps below to install the Fn client on Windows. -- Download the script:<> locally and execute in below way to see the current system state. -- Open PowerShell as Administrator(```click Start > Windows PowerShell > Run as Administrator```) -- Execute command ```Get-ExecutionPolicy``` and note down the outcome as it is needed in subsequent steps. -- Execute command ```Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy Unrestricted -Force;``` -- Execute command ```<>\fn_installer.ps1 "fn-client-install"``` +- Download the script:<> locally and execute in below way. + - - ```<>``` is fully-qualified path of downloaded script. For example: ```C:\Users\<>\Downloads\fn_install\``` +- Open PowerShell as Administrator + ``` + click Start > Windows PowerShell > Run as Administrator + ``` +- Execute command in opened PowerShell and note down the outcome as it is needed in subsequent steps. + ``` + Get-ExecutionPolicy + ``` -- Once done with script execution, execute command ```Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy <> -Force;``` +- Execute command in opened PowerShell + ``` + Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy Unrestricted -Force; + ``` +- Execute command in opened PowerShell. This will install the latest fn client. More details: + ``` + <>\fn_installer.ps1 "fn-client-install" + ``` + ***<>*** is fully-qualified path of downloaded script. *For example:* + ```C:\Users\<>\Downloads\fn_install\``` + + +- Once done with above steps, execute command in opened PowerShell + ``` + Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy <> -Force; + ``` + + ***<>*** this is same as the outcome you noted down after execution of command ```Get-ExecutionPolicy``` above. + - - ```<>``` this is same as the outcome you noted down after execution of command ```Get-ExecutionPolicy``` above. - - close the opened ```Powershell``` +- Close the opened PowerShell -Now when you open a Windows **Command Prompt**, and execute command ```fn version```. +Now when you open a Windows **Command Prompt**, and execute command ```fn version```. It should show the fn version. ### (3) Install the Linux Subsystem for Windows The Linux subsystem for Windows is now a standard feature of Windows as of build 16215. The Linux Fn client runs fine in the subsystem. To install the Fn client do the following: From 4064188f548e334056e43f991d49b26e34d50e1c Mon Sep 17 00:00:00 2001 From: Purushottam Ray Date: Thu, 19 Aug 2021 15:07:46 +0530 Subject: [PATCH 3/5] Changed the doc --- fn/develop/running-fn-client-windows.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/fn/develop/running-fn-client-windows.md b/fn/develop/running-fn-client-windows.md index 1733095..b6c0677 100644 --- a/fn/develop/running-fn-client-windows.md +++ b/fn/develop/running-fn-client-windows.md @@ -27,7 +27,7 @@ To install Docker, you have to have all of the following. **Note:** *Above system need can change with newer docker desktop versions.More on requirements, check: .* - *You can also download the script:<> locally and execute in below way to see the current system state and see whether it is meeting the above need, otherwise Docker desktop will not work.* + *You can also download the script: locally and execute in below way to see the current system state and see whether it is meeting the above need, otherwise Docker desktop will not work.* - Open PowerShell as Administrator ``` click Start > Windows PowerShell > Run as Administrator @@ -84,7 +84,7 @@ With Docker installed, you are ready to install the Fn client. ## Install Fn Client Follow the steps below to install the Fn client on Windows. -- Download the script:<> locally and execute in below way. +- Download the script: locally and execute in below way. - Open PowerShell as Administrator From d3c7433dd5e4b0305fb49ebecdbbc696f6319d50 Mon Sep 17 00:00:00 2001 From: Purushottam Ray Date: Thu, 19 Aug 2021 15:22:53 +0530 Subject: [PATCH 4/5] Changed the doc --- fn/develop/running-fn-client-windows.md | 28 ++++++++----------------- 1 file changed, 9 insertions(+), 19 deletions(-) diff --git a/fn/develop/running-fn-client-windows.md b/fn/develop/running-fn-client-windows.md index b6c0677..dd01d49 100644 --- a/fn/develop/running-fn-client-windows.md +++ b/fn/develop/running-fn-client-windows.md @@ -27,7 +27,7 @@ To install Docker, you have to have all of the following. **Note:** *Above system need can change with newer docker desktop versions.More on requirements, check: .* - *You can also download the script: locally and execute in below way to see the current system state and see whether it is meeting the above need, otherwise Docker desktop will not work.* + *You can also download the script: locally and place it at location(```c:\fn_install\```) and execute in below way to see the current system state and see whether it is meeting the above need, otherwise Docker desktop will not work properly.* - Open PowerShell as Administrator ``` click Start > Windows PowerShell > Run as Administrator @@ -43,23 +43,16 @@ To install Docker, you have to have all of the following. - Execute command in opened PowerShell. Outcome of command will show your system state. ``` - <>\fn_installer.ps1 "get-system-state" + c:\fn_install\fn_installer.ps1 "get-system-state" ``` - - ***<>*** is fully-qualified path of downloaded script. *For example:* - ```C:\Users\<>\Downloads\fn_install\``` - - + - If just above step is showing that ```Hyper-V``` is not enabled then you can run command in opened PowerShell. This will enable the ```Hyper-V```. This step may result in system restart, please do follow the steps below post restart. ``` - <>\fn_installer.ps1 "enable-hyperviser" + c:\fn_install\fn_installer.ps1 "enable-hyperviser" ``` - ***<>*** is fully-qualified path of downloaded script. *For example:* - ```C:\Users\<>\Downloads\fn_install\``` - - + - Once done with above steps, execute command in opened PowerShell ``` Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy <> -Force; @@ -84,8 +77,8 @@ With Docker installed, you are ready to install the Fn client. ## Install Fn Client Follow the steps below to install the Fn client on Windows. -- Download the script: locally and execute in below way. - +- Download the script: locally and place it at location(```c:\fn_install\```) if not done earlier and execute in below way. + - Open PowerShell as Administrator ``` @@ -102,12 +95,9 @@ Follow the steps below to install the Fn client on Windows. ``` - Execute command in opened PowerShell. This will install the latest fn client. More details: ``` - <>\fn_installer.ps1 "fn-client-install" + c:\fn_install\fn_installer.ps1 "fn-client-install" ``` - ***<>*** is fully-qualified path of downloaded script. *For example:* - ```C:\Users\<>\Downloads\fn_install\``` - - + - Once done with above steps, execute command in opened PowerShell ``` Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy <> -Force; From 87cee93ec1818d095fe91ad144d1962ef0164a3c Mon Sep 17 00:00:00 2001 From: Purushottam Ray Date: Thu, 19 Aug 2021 15:29:02 +0530 Subject: [PATCH 5/5] Changed the doc --- fn/develop/running-fn-client-windows.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/fn/develop/running-fn-client-windows.md b/fn/develop/running-fn-client-windows.md index dd01d49..a1c6eff 100644 --- a/fn/develop/running-fn-client-windows.md +++ b/fn/develop/running-fn-client-windows.md @@ -43,14 +43,14 @@ To install Docker, you have to have all of the following. - Execute command in opened PowerShell. Outcome of command will show your system state. ``` - c:\fn_install\fn_installer.ps1 "get-system-state" + c:\fn_install\fn_windows_installer.ps1 "get-system-state" ``` - If just above step is showing that ```Hyper-V``` is not enabled then you can run command in opened PowerShell. This will enable the ```Hyper-V```. This step may result in system restart, please do follow the steps below post restart. ``` - c:\fn_install\fn_installer.ps1 "enable-hyperviser" + c:\fn_install\fn_windows_installer.ps1 "enable-hyperviser" ``` - Once done with above steps, execute command in opened PowerShell @@ -95,7 +95,7 @@ Follow the steps below to install the Fn client on Windows. ``` - Execute command in opened PowerShell. This will install the latest fn client. More details: ``` - c:\fn_install\fn_installer.ps1 "fn-client-install" + c:\fn_install\fn_windows_installer.ps1 "fn-client-install" ``` - Once done with above steps, execute command in opened PowerShell