A small and simple dashboard application to show sakuli VNC-views and monitoring metrics.
- Configurable display layout
- Configurable play button to perform actions on k8s cluster
- Automated display updates after play button has been clicked
- Automated updates on displays in case the service is only temporarily available
- Optional, configurable user authentication.
A k8s API is necessary in order to perform e2e-tests.
npm i && npm run rebuild- Alter test environment configuration in
setTestEnvironment.sh - Load configuration
source setLocalTestEnvironment.shfor test environment config - depends on local setup.
npm run start:dev
Versioning is based on SemVer with the addition that config changes are also released and tagged as a patch release.
Interface implementation can be found in server/src/config.
| Environment variable | description | interface implementation |
|---|---|---|
| DASHBOARD_CONFIG | configures the displays (ordering, url, actions, etc.) shown in the dashboard | dashboard.config.ts |
| ACTION_CONFIG | available actions to perform on the k8s cluster and corresponding display updates | dashboard-actions.config.ts |
| CLUSTER_CONFIG | configures the cluster access (cluster address, access token, etc.) | k8s-cluster.config.ts |
| CRONJOB_CONFIG | configures a cronjob to start a specific action | cronjob.config.ts |
| AUTHENTICATION_CONFIG | configures the authentication of the dashboard | authenticationConfig.ts |
To use an available action in a display configuration, the corresponding actionIdentifier defined in ACTION_CONFIG must be used.