You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-6
Original file line number
Diff line number
Diff line change
@@ -80,23 +80,31 @@ Run storybook a11y tests and interaction tests.
80
80
81
81
For in-depth testing guidance review the [contribution guidelines](./CONTRIBUTING.md#Testing)
82
82
83
-
## Deploying the ODH Dashbard
83
+
## Deploying the MCAD Dashbard
84
84
85
85
### Official Image Builds
86
86
87
-
odh-dashboard images are automatically built and pushed to [quay.io](https://quay.io/repository/opendatahub/odh-dashboard) after every commit to the `main` branch. The image tag name format for each image is `main-<COMMIT SHORT HASH>`.
87
+
`mcad-dashboard` images are automatically built and pushed to [ghcr.io](https://github.com/orgs/project-codeflare/packages?repo_name=mcad-dashboard) after every commit to the `main` branch. The image tag name format for each image is `<COMMIT HASH>`.
88
88
89
-
Example: The `main` branch is updated with commit `f76e3952834f453b1d085e8627f9c17297c2f64c`. The CI system will automatically build an odh-dashboard image based on that code and push the new image to `odh-dashboard:main-f76e395` and updated `odh-dashboard:main` to point to the same image hash.
89
+
The same naming scheme is trueforthe `mcad-exporter` images.
90
90
91
-
The [nightly](https://quay.io/opendatahub/odh-dashboard:nightly) tag is a floating tag that is updated nightly and points to the most recent `main-<HASH>` commit from the previous day.
91
+
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.
92
+
93
+
### Deployment requirements
94
+
95
+
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.
96
+
97
+
### Deploy using make (recommended)
98
+
99
+
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.
92
100
93
101
### Deploy using kustomize
94
102
95
-
The [manifests](./manifests) folder contains a [kustomize](https://kustomize.io) manifest that can be used with `kustomize build`.
103
+
Alternatively, the [manifests](./manifests) folder contains a [kustomize](https://kustomize.io) manifest that can be used with `kustomize build` directly.
96
104
97
105
### Deploy using a kfdef
98
106
99
-
The [manifests/kfdef](./manifests/kfdef) folder contains an example kfdef to deploy ODH Dashboard with the Notebook Controller backend is located in [odh-dashboard-kfnbc-test.yaml](manifests/kfdef/odh-dashboard-kfnbc-test.yaml).
107
+
Alternatively, the [manifests/kfdef](./manifests/kfdef) folder contains an example kfdef to deploy ODH Dashboard with the Notebook Controller backend is located in [odh-dashboard-kfnbc-test.yaml](manifests/kfdef/odh-dashboard-kfnbc-test.yaml).
0 commit comments