Prepare your development environment on Windows

To build and run Azure Service Fabric applications on your Windows development machine, install the Service Fabric runtime, SDK, and tools. You also need to enable execution of the Windows PowerShell scripts included in the SDK.

Prerequisites

Supported operating system versions

The following operating system versions are supported for development:

  • Windows 7
  • Windows 8/Windows 8.1
  • Windows Server 2012 R2
  • Windows Server 2016
  • Windows 10

Note

Windows 7 support:

  • Windows 7 only includes Windows PowerShell 2.0 by default. Service Fabric PowerShell cmdlets requires PowerShell 3.0 or higher. You can download Windows PowerShell 5.0 from the Microsoft Download Center.
  • Service Fabric Reverse Proxy is not available on Windows 7.

Install the SDK and tools

Web Platform Installer (WebPI) is the recommended way to install the SDK and tools. If you receive runtime errors using WebPI, you can also find direct links to the installers in the release notes for a specific Service Fabric release. The release notes can be found in the various release announcements on the Service Fabric team blog.

To use Visual Studio 2017

The Service Fabric Tools are part of the Azure Development workload in Visual Studio 2017. Enable this workload as part of your Visual Studio installation. In addition, you need to install the Microsoft Azure Service Fabric SDK and runtime using Web Platform Installer.

To use Visual Studio 2015 (requires Visual Studio 2015 Update 2 or later)

For Visual Studio 2015, the Service Fabric tools are installed together with the SDK and runtime using the Web Platform Installer:

SDK installation only

If you only need the SDK, you can install this package:

The current versions are:

  • Service Fabric SDK and Tools 3.3.617
  • Service Fabric runtime 6.4.617
  • Service Fabric Tools for Visual Studio 2015 2.4.11116.1
  • Visual Studio 2017 15.9 includes Service Fabric Tools for Visual Studio 2.4.11024.1

For a list of supported versions, see Service Fabric support

Note

Single machine clusters (OneBox) are not supported for Application or Cluster upgrades; delete the OneBox cluster and recreate it if you need to perform a Cluster upgrade, or have any issues performing an Application upgrade.

Enable PowerShell script execution

Service Fabric uses Windows PowerShell scripts for creating a local development cluster and for deploying applications from Visual Studio. By default, Windows blocks these scripts from running. To enable them, you must modify your PowerShell execution policy. Open PowerShell as an administrator and enter the following command:

Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Force -Scope CurrentUser

Install Docker (optional)

Service Fabric is a container orchestrator for deploying microservices across a cluster of machines. To run Windows container applications on your local development cluster, you must first install Docker for Windows. Get Docker CE for Windows (stable). After installing and starting Docker, right-click on the tray icon and select Switch to Windows containers. This step is required to run Docker images based on Windows.

Next steps

Now that you've finished setting up your development environment, start building and running apps.