Skip to content

Latest commit

 

History

History
83 lines (56 loc) · 4.11 KB

GettingStartedWindows.md

File metadata and controls

83 lines (56 loc) · 4.11 KB

Getting Started with Windows

Required tools can be installed locally, or via a Docker Windows Container build image.

Local Build Prerequisites

The following must be installed in order to build this project:

  1. Git (e.g., Git for Windows 64-bit)

  2. Visual Studio 2022 - one of the following editions should be installed (once installed, upgrade to v17.4.2 or later):

    during the installation, select the following feature from the Visual Studio Installer:

    • "Desktop development with C++"
    • "The Windows 10 or 11 SDK"

    including the following Spectre library, which must be selected from the "Individual components" tab in the Visual Studio Installer:

    • "MSVC v143 - VS 2022 C++ x64/x86 Spectre-mitigated libs (latest)"

  3. WDK for Windows 11, version 22H2 (version 10.0.22621.x), including the "Windows Driver Kit Visual Studio extension" (make sure the "Install Windows Driver Kit Visual Studio Extension" check box is checked before completing the installer).

    Note: as multiple versions of WDKs cannot coexist side-by-side, you may be asked to uninstall previous versions.

  4. Clang for Windows 64-bit (version 11.0.1). Note: clang versions 12 and higher are NOT yet supported, as they perform program optimizations that are incompatible with the PREVAIL verifier.

  5. NuGet Windows x86 Command-line (version 6.31 or higher), which can be installed to a location such as "C:\Program Files (x86)\NuGet".

  6. Installing rustup on Windows, to start using Rust, download the installer, then run the program and follow the default onscreen instructions.

You should add the paths to git.exe and nuget.exe to the Windows PATH environment variable after the software packages above have been installed.

How to clone and build the project

This section outlines the steps to build, prepare and build this project.

Cloning the project

  1. git clone https://github.com/Azure/GuestProxyAgent.git. By default this will clone the project under the GuestProxyAgent directory.

Build the project

  1. Launch Developer Command Prompt for VS 2022 with administrators permission.
  2. Navigate to this repo root folder.
  3. build.cmd

Building with Docker

If you are prefer an isolated build environment, you can use the Windows Container build image.

Windows Containers don't have full Docker feature support. Additionally, the image is very large at ~30GB. If either of these are concern, use the previous instructions.

cd docker/windows
docker-compose build
docker-compose up --detach
docker-compose exec gpawindev cmd

Within the attached container, the full build, all tests, and all packaging can be run with:

vs-init
build

In certain Windows environments you may notice inordinately slow downloads during the docker image build. If you are in one of these edge cases, consider disabling RCS which can potentially help: powershell "Get-NetAdapterRSC | Disable-NetAdapterRSC"

Other tips

  • If your setup is relying on OpenSSH for container communication, use a modern version of OpenSSH for better performance. On Windows, this can be installed with winget install -e --id Microsoft.OpenSSH.Beta.
  • Docker Desktop can only manage Windows or Linux containers at one time. Right-click on the Docker icon in the system tray and select Switch to windows containers... or Switch to linux containers... as needed.