service-fabric-explorer - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #typescript #go #machine-learning #deep-learning #nodejs #windows #kubernetes #awesome-list #security #pytorch #ios #open-source

service-fabric-explorer

(★ 113)

Service Fabric Explorer is a web based dashboard for visualizing the state of a Service Fabric cluster.

File Explorer

Download Latest Version (.zip)

- - codeql-config.yml
- - bug_report.md
  - feature_request.md
- - build.yml
  - codeql-analysis.yml
- launch.json
- mcp.json
- settings.json
- - .gitignore
  - appsettings.json
  - package-lock.json
  - package.json
  - proxy.js
- - .browserslistrc
  - .editorconfig
  - .gitignore
  - angular.json
  - combined.js
  - cypress.config.ts
  - eslint.config.js
  - karma.conf.js
  - package-lock.json
  - package.json
  - proxy.conf.json
  - README.md
  - replaceEnvVars.js
  - sfx.nuspec
  - tsconfig.app.json
  - tsconfig.json
  - tsconfig.spec.json
.gitattributes
.gitignore
LICENSE
README.md
SECURITY.md
sfx.code-workspace
ThirdPartyNotices.txt

# Installation Guide

1. Get the code

git clone https://github.com/microsoft/service-fabric-explorer

Downloads the entire project code from GitHub to your computer.

cd service-fabric-explorer

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

Node.js Node.js must be installed to use npm.

npm install -g @angular/cli

Installs the package published on the npm registry globally — no need to clone the source.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install -g @angular/cli

Installs the package published on the npm registry globally — no need to clone the source.

npm install

Downloads and installs the libraries listed in package.json.

npm run build

Builds optimized production files.

npm run build:prod

Builds optimized production files.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 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
------------ | -------------
![Image of Windows Build Badge](https://ci.appveyor.com/api/projects/status/ejfk6b0c3dlunkws/branch/master) | ![Image of Linux/macOS Build Badge](https://travis-ci.org/Microsoft/service-fabric-explorer.svg?branch=master)

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
### Preparing the development machine

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

* Git: https://git-scm.com/
* Node.js (use LTS version): https://nodejs.org/

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

1. Clone the master branch.
`git clone --recurse-submodules https://github.com/Microsoft/service-fabric-explorer.git <path to the local folder>`
2. Install project dependencies: *This can be done inside VSCode or use a console window.*
   1. [SFX] install the following [CLI](https://angular.io/cli) for the angular project 
   ```Shell
   npm install -g @angular/cli
   ```
   1. [SFX] Navigate to `src/SfxWeb` and run the following scripts.
   ```Shell
   npm install   
   ```

1. [SFX Proxy] Navigate to `src/Sfx-Proxy` and run the following scripts.
   ```Shell
   npm install   
   ```

3. Build projects
   * VSCode
      1. Open `src/SfxWeb` and `src/Sfx-Proxy` in VSCode with multiple-root workspce.
   * Console
      1. [SFX] Navigate to `src/SfxWeb` and run the following scripts.
      For a develop/quick build
      ```Shell
      npm run build
      ```
      For a production build
      ```
      npm run build:prod
      ```

### Develop Locally and Run Local Proxy
Navigate to `src/SfxWeb`
```Shell
npm start
```
Navigate to `src/Sfx-Proxy`
```Shell
npm start
```

> [!NOTE]  
> SFX-Proxy is a local dev tool to forward cluster requests for testing purposes. It should not be hosted as a public server.

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
```Shell
npm start -- r p
```

If proxying requests to a secure cluster adding a file called localsettings.json to src/Sfx-Proxy can take a cert pfx location like below.  
```
{
  "TargetCluster": {
    "Url": "https://test.eastus.cloudapp.azure.com:19080",
    "PFXLocation": "C:/some_cert.pfx",
    "PFXPassPhrase": "password",
    "CALocation": "C:\some_ca.pem" //only needed for self signed cert
  },
  "recordFileBase": "playbackRecordings/"
}
```
If the certificate for the cluster is self signed, which is often the case for test sfrp clusters, add the CALocation as well.  The pem file can be generated from the pfx file using openssl.
```
openssl pkcs12 -in C:/some_cert.pfx -out C:/some_ca.pem -nodes
```

## Testing

### Run unit tests
Navigate to  `src/SfxWeb` folder and run 
```
npm test
```

### Run E2E tests
Navigate to src/SfxWeb folder and run
```
npm run cypress:local
```
This assumes that the angular local dev server is running

### Generate test coverage report
(see the following for reference https://lukas-klement.medium.com/implementing-code-coverage-with-angular-and-cypress-6ed08ed7e617)

Run a full E2E suite above and this will generate a code coverage report.
Navigate to src/SfxWeb folder and run
```
npm run test:coverage
```
Then you can also view a full report at
```
sfxWeb/coverage/lcov-report/index.html
```

### CI overview
The CI will run the following

* production build
* unit tests
* E2E tests

## Issues and questions

For questions related to Azure Service Fabric clusters, take a look at the [tag on StackOverflow](https://stackoverflow.com/questions/tagged/azure-service-fabric)
and [official documentation](https://docs.microsoft.com/en-us/azure/service-fabric/).

### General Service Fabric issues

If your issue is not specific to the Service Fabric Explorer, please use the [Service Fabric issues repository](https://github.com/Azure/service-fabric-issues/issues) 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