A dashboard for Multi-Cluster App Dispatcher and Open Data Hub components.
MCAD/ ODH Dashboard Installation and Components:
- Shows what's installed
- Show's what's available for installation
- Links to component UIs
- Links to component documentation
For more detailed current features of the MCAD dashboard:
For deployment of MCAD Dashboard:
ODH requires the following to run:
- NodeJS and NPM
- Node recommended version ->
18.16.0
- NPM recommended version ->
9.6.7
- Node recommended version ->
- OpenShift CLI
- kustomize
- podman
- Have access to Quay.io
-
Clone the repository
git clone https://github.com/project-codeflare/mcad-dashboard
-
Within the repo context, install project dependencies
cd odh-dashboard && npm install
npm run build
This is the default context for running a local UI. Make sure you build the project using the instructions above prior to running the command below.
npm run start
For in-depth local run guidance review the contribution guidelines.
Run the tests.
npm run test
Run storybook a11y tests and interaction tests.
npm run storybook
npm run test:storybook
For in-depth testing guidance review the contribution guidelines
mcad-dashboard
images are automatically built and pushed to ghcr.io after every commit to the main
branch. The image tag name format for each image is <COMMIT HASH>
.
The same naming scheme is true for the mcad-exporter
images.
Example: The main
branch is updated with commit f76e3952834f453b1d085e8627f9c17297c2f64c
. The CI system will automatically build an mcad-dashboard image based on that code and push the new image to mcad-dashboard:main-f76e395
and updated mcad-dashboard:main
to point to the same image hash.
Deploying the MCAD Dashboard and exporter requires the installation of the ODH operator on your K8s cluster. Then, login using make login
or an oc login
command to your cluster.
One can deploy all the relevant components using make deploy
, which executes a series of kustomize
commands from the manifests/
folder in the repo. In the same manner, the relevant components can be removed from your cluster.
Alternatively, the manifests folder contains a kustomize manifest that can be used with kustomize build
directly.
Alternatively, the manifests/kfdef folder contains an example kfdef to deploy ODH Dashboard with the Notebook Controller backend is located in odh-dashboard-kfnbc-test.yaml.
Contributing encompasses repository specific requirements.
For information on how we triage tickets, see our triage.md.
You can find more information about this project in the document section.
For more information on how, when, and what we do for releases, see our releases.md.