Apache YuniKorn Web UI - Incubating

Clone this repo:
  1. b66e919 [YUNIKORN-1305] git sha label substitution (#89) by Wilfred Spiegelenburg · 7 days ago master
  2. c8f6d04 [YUNIKORN-1290] Support aarch64 and arm64 for ARM processors (#88) by 0yukali0 · 6 weeks ago
  3. b3d3c7e [YUNIKORN-1136] Show absolute used capacity in web UI (#87) by Craig Condit · 7 weeks ago
  4. f635858 [YUNIKORN-1256] license issues in deployments examples (#86) by Wilfred Spiegelenburg · 8 weeks ago
  5. 08b24d1 [YUNIKORN-1259] Remove "How to contribute" doc (#85) by 0yukali0 · 3 months ago

Yunikorn web UI

YuniKorn web provides a web interface on top of the scheduler. It provides insight in the current and historic scheduler status. It depends on yunikorn-core which encapsulates all the actual scheduling logic.

For detailed information on the components and how to build the overall scheduler please see the yunikorn-core.

This project was generated with Angular CLI version 13.3.0.

Development Environment setup

Dependencies

The project requires a number of external tools to be installed before the build and development:

Development server

Run make start-dev for a development server. Navigate to http://localhost:4200/. The application will automatically reload if you change any of the source files.

Build

Run make build to build the project. The build artifacts will be stored in the dist/ directory. Use make build-prod for a production build. Production builds will add the --prod flag to the angular build.

Docker image build

Image builds are geared towards a production build and will always build with the --prod flag set.

Run make image to build the docker image apache/yunikorn:web-latest. Run make run to build the image and deploy the container from the docker image apache/yunikorn:web-latest.

You can set REGISTRY and VERSION in the commandline to build docker image with a specified version and registry. For example,

make image REGISTRY=apache VERSION=latest

This command will build binary with version web-latest and the docker full image tag is apache/yunikorn:web-latest.

Run make deploy-prod to build and deploy the scheduler webapp using docker-compose. The project uses multi-stage build feature of the docker and requires Docker 17.05 or higher.

Running tests

All tests can be executed via make test. It will first build the project and then execute the unit tests followed by the end to end tests.
If you want to run the unit tests separately, run yarn test to execute them via Karma. If you want to run the unit tests with code coverage, run yarn test:coverage.

Local development

Beside the simple all in way to start the development server via make you can also start a development environment manually.

The application depends on json-server for data. Install json-server locally. Run yarn start:srv to start json-server for local development. Run yarn start to start the angular development server and navigate to http://localhost:4200/.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.

Code scaffolding

Run ng generate component component-name to generate a new component.

You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

Port configurations

The default port used for the web server is port 9889 and is set in the nginx/nginx.conf.

The port is also referenced in other scripts and configurations to this port also, if you change the port make sure that the other locations are updated:

  • Makefile

How do I contribute code?

See how to contribute code from this guide.