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.
The project requires a number of external tools to be installed before the build and development:
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.
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.
Image builds are geared towards a production build and will always build with the
--prod flag set.
make image to build the docker image
make run to build the image and deploy the container from the docker image
You can set
VERSION in the commandline to build docker image with a specified version and tag. For example,
make image TAG=yunikorn/yunikorn-web VERSION=latest
this command will build binary with version
latest and the docker image tag is
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.
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
The end to end tests run via Protractor and can be directly run by executing
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
To get more help on the Angular CLI use
ng help or go check out the Angular CLI README.
ng generate component component-name to generate a new component.
You can also use
ng generate directive|pipe|service|class|guard|interface|enum|module.
The configurations for the endpoints of scheduler and prometheus should be provided in the
The web address can be configured as
":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
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:
See how to contribute code from this guide.