[ovs-dev] [PATCH 1/2] Documentation, windows: Document how to generate the Windows installer

Alin Gabriel Serdean aserdean at cloudbasesolutions.com
Tue Sep 8 02:04:07 UTC 2020


This patch adds information on how to generate the Windows installer
which can be used to easily deploy the userspace binaries, kernel module
and create services on new environments.

Signed-off-by: Alin Gabriel Serdean <aserdean at cloudbasesolutions.com>
---
v2: Change line endings at 79 characters
---
 Documentation/intro/install/windows.rst | 31 +++++++++++++++++++------
 1 file changed, 24 insertions(+), 7 deletions(-)

diff --git a/Documentation/intro/install/windows.rst b/Documentation/intro/install/windows.rst
index 394572f00..caa8dd062 100644
--- a/Documentation/intro/install/windows.rst
+++ b/Documentation/intro/install/windows.rst
@@ -71,7 +71,10 @@ The following explains the steps in some detail.
 
   You will need at least Visual Studio 2013 (update 4) to compile userspace
   binaries.  In addition to that, if you want to compile the kernel module you
-  will also need to install Windows Driver Kit (WDK) 8.1 Update.
+  will also need to install Windows Driver Kit (WDK) 8.1 Update or later.
+  To generate the Windows installer you need
+  `WiX Toolset <https://wixtoolset.org/>`__ and also be able to build the
+  kernel module.
 
   It is important to get the Visual Studio related environment variables and to
   have the $PATH inside the bash to point to the proper compiler and linker.
@@ -319,6 +322,21 @@ An alternative way to do the same is to run the following command:
    seconds has been observed for the change to be reflected in the UI.  This is
    not a bug in Open vSwitch.
 
+Generate the Windows installer
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To generate the Windows installler run the following command from the top
+source directory:
+
+::
+
+   $ make windows_installer
+
+.. note::
+   This will generate the Windows installer in the following location (relative
+   to the top source directory):
+   windows/ovs-windows-installer/bin/Release/OpenvSwitch.msi
+
 Starting
 --------
 
@@ -785,10 +803,10 @@ Windows CI Service
 ------------------
 
 `AppVeyor <www.appveyor.com>`__ provides a free Windows autobuild service for
-open source projects.  Open vSwitch has integration with AppVeyor for continuous
-build.  A developer can build test his changes for Windows by logging into
-appveyor.com using a github account, creating a new project by linking it to
-his development repository in github and triggering a new build.
+open source projects.  Open vSwitch has integration with AppVeyor for
+continuous build.  A developer can build test his changes for Windows by
+logging into appveyor.com using a github account, creating a new project by
+linking it to his development repository in github and triggering a new build.
 
 TODO
 ----
@@ -797,5 +815,4 @@ TODO
 
 * Investigate and add the feature to provide QoS.
 
-* Sign the driver & create an MSI for installing the different Open vSwitch
-  components on Windows.
+* Sign the driver.
-- 
2.27.0.windows.1



More information about the dev mailing list