Apache YuniKorn Web UI - Incubating

Clone this repo:
  1. 3ccb4e4 [YUNIKORN-300] update nginx image (#43) by Wilfred Spiegelenburg · 2 weeks ago master
  2. 3c4b87c [YUNIKORN-267] revert landmark changes (#42) by Wilfred Spiegelenburg · 4 weeks ago
  3. 50acc6f YUNIKORN-250: Display queue properties in queues page (#41) by AKHIL PB · 5 weeks ago
  4. 0179726 YUNIKORN-233: Change default pagesize of datatable in yunikorn-web to 10 (#40) by AKHIL PB · 6 weeks ago
  5. 4929d6e YUNIKORN-214: Fix travis build failure in yunikorn-web (#39) by AKHIL PB · 8 weeks 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 8.3.19.

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 yunikorn-web. Run make run to build the image and deploy the container from the docker image yunikorn-web.

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

make image REGISTRY=yunikorn VERSION=latest

This command will build binary with version web-latest and the docker full image tag is yunikorn/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.

The end to end tests run via Protractor and can be directly run by executing yarn e2e.

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.

Endpoint configurations

The configurations for the endpoints of scheduler and prometheus should be provided in the src/assets/config/envconfig.json file.

The web address can be configured as "hostname:port" or ":port". If there is no hostname provided, the hostname will be inferred from the URL at which the UI is running. 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:

  • docker-compose.yml
  • docker_start.sh
  • Makefile

How do I contribute code?

See how to contribute code from this guide.