Service Fabric Explorer (SFX)

Service Fabric Explorer is an application for inspecting and managing cloud applications and nodes in a Microsoft Azure Service Fabric cluster.

Build Status

Windows	Linux / macOS

Installation

Microsoft publishes the following installer packages for SFX:

Windows
- https://aka.ms/sfx-windows
Linux
- https://aka.ms/sfx-linux-x86
- https://aka.ms/sfx-linux-x64
macOS
- https://aka.ms/sfx-macos

For more information about the application and how to use it: https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-visualizing-your-cluster

Developer Help and Documentation

Service Fabric Explorer consists of two main components, an AngularJS based application (Sfx) and an Electron part to host the AngularJS application (Sfx-Standalone).

Preparing the development machine

To develop Service Fabric Explorer, the following components are required.

Git: https://git-scm.com/
Python 2: https://www.python.org/
Node.js (Latest is preferred): https://nodejs.org/
C++ Compiler
- Windows: Visual C++ https://www.visualstudio.com/
- Ubuntu: sudo apt-get install -y build-essential

The recommended IDE for Service Fabric Explorer development is VSCode because VSCode is a cross-platform editor, which supports Windows, Linux and macOS. But you can use whatever editor to develop.

Here's a list of common IDE used.

VSCode: https://code.visualstudio.com/
Visual Studio: https://www.visualstudio.com/

Set up the development environment

Clone the master branch. git clone --recurse-submodules https://github.com/Microsoft/service-fabric-explorer.git <path to the local folder>
Install project dependencies: This can be done inside VSCode or use a console window.
1. [SFX] Navigate to src/Sfx and run the following scripts.
```
npm install   
```
1. [SFX Standalone] Navigate to src/Sfx-Standalone and run the following scripts.
```
npm install
```
1. [SFX Tests] Navigate to test/SfxTests and run the following scripts.
```
npm install   
```
1. [SFX Proxy] Navigate to src/Sfx-Proxy and run the following scripts.
```
npm install   
```
Build projects
- VSCode
  1. Open src/Sfx, src/Sfx-Standalone and test/SfxTests in VSCode with multiple-root workspce.
  2. Run following tasks orderly.
    - clean-build for Sfx
    - clean-build for Sfx-Standalone
    - clean-build for SfxTests
- Console
  1. Install Gulp globally on the machine.
```
npm install gulp-cli -g
```
  1. [SFX] Navigate to src/Sfx and run the following scripts.
```
gulp clean-build
```
  1. [SFX Standalone] Navigate to src/Sfx-Standalone and run the following scripts.
```
gulp clean-build
```
  1. [SFX Tests] Navigate to test/SfxTests and run the following scripts.
```
gulp clean-build
```

Run Local http server/Proxy

Navigate to src/Sfx-Proxy

npm start

There are 2 optional flags -r which would record every request to a folder(by default called playbackRecordings) and overwriting if the same request is made again -p every request will be checked for a saved response and if one exists get served instead

npm start -- -r -p

If proxying requests to a secure cluster the appsettings.json can also take a cert pfx location like { "TargetCluster": { "Url": "https://jejarryacesstesting.eastus.cloudapp.azure.com:19080", "PFXLocation": "C:/some_cert.pfx", "PFXPassPhrase": "password" }, "recordFileBase": "playbackRecordings/" }

Run unit tests for Sfx

Open test/SfxTests in VSCode or Navigate to test/SfxTests in console and run the ut gulp task.

Issues and questions

For questions related to Azure Service Fabric clusters, take a look at the tag on StackOverflow and official documentation.

General Service Fabric issues

If your issue is not specific to the Service Fabric Explorer, please use the Service Fabric issues repository to report an issue.

Service Fabric Explorer specific issues

If your issue is relevant to the Service Fabric Explorer, please use this repositories issue tracker.

Be sure to search for similar previously reported issues prior to creating a new one. In addition, here are some good practices to follow when reporting issues:

Add a +1 reaction to existing issues that are affecting you
Include detailed output or screenshots when reporting unexpected error messages
Include the version of SFX installed
Include the version of Service Fabric runtime for the cluster you have selected

New ideas and improvements

We encourage everyone to contribute to this project, following the contribution guidelines below. If you have ideas and want to share these with the community before taking on implementing the change, feel free to suggest these using issues.

Contribution guidelines

For general contribution guidelines, plese see here: https://github.com/Microsoft/service-fabric/blob/master/CONTRIBUTING.md

jagilber/service-fabric-explorer