windows/README.rst

   1 ..
   2       Licensed under the Apache License, Version 2.0 (the "License"); you may
   3       not use this file except in compliance with the License. You may obtain
   4       a copy of the License at
   5
   6           http://www.apache.org/licenses/LICENSE-2.0
   7
   8       Unless required by applicable law or agreed to in writing, software
   9       distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  10       WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  11       License for the specific language governing permissions and limitations
  12       under the License.
  13
  14       Convention for heading levels in Open vSwitch documentation:
  15
  16       =======  Heading 0 (reserved for the title in a document)
  17       -------  Heading 1
  18       ~~~~~~~  Heading 2
  19       +++++++  Heading 3
  20       '''''''  Heading 4
  21
  22       Avoid deeper levels because they do not render well.
  23
  24 ==============
  25 Windows README
  26 ==============
  27
  28 This directory contains tooling to generate an MSI installer for Open vSwitch
  29 on Windows, including CLI executables, services and the Hyper-V vswitch
  30 forwarding extension.
  31
  32 Requirements
  33 ------------
  34
  35 * Visual Studio 2013
  36
  37   Community, Professional, Premium or Ultimate editions can be used.
  38
  39   Visual Studio Community 2013 is freely available from `visualstudio.com
  40   <https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx>`__
  41
  42 * WiX Toolset 3.9
  43
  44   Download and install from `wixtoolset.org
  45   <http://wixtoolset.org/releases/v3.9/stable>`__
  46
  47 * ``Microsoft_VC120_CRT_x86.msm``
  48
  49   This Windows merge module is available with Visual Studio and contains the
  50   Visual C++ 2013 x86 runtime redistributables files.  Copy the file in the
  51   ``Redist`` directory.
  52
  53 Open vSwitch installer
  54 ----------------------
  55
  56 The installer will be generated under the following path::
  57
  58     windows\ovs-windows-installer\bin\Release\OpenvSwitch.msi
  59
  60 .. note::
  61
  62   The kernel driver needs to be signed.
  63
  64 Build Instructions
  65 ------------------
  66
  67 Build the solution in the Visual Studio IDE or via command line::
  68
  69     msbuild ovs-windows-installer.sln /p:Platform=x86 /p:Configuration=Release
  70
  71 Silent installation
  72 -------------------
  73
  74 ::
  75
  76     msiexec /i OpenvSwitch.msi ADDLOCAL=OpenvSwitchCLI,OpenvSwitchDriver /l*v log.txt