Skip to content
This repository has been archived by the owner on Jan 31, 2024. It is now read-only.

Commit

Permalink
Update the README for ODH Core components
Browse files Browse the repository at this point in the history
Signed-off-by: Landon LaSmith <[email protected]>
  • Loading branch information
LaVLaS committed Jun 26, 2023
1 parent 5bddd34 commit 30a393f
Showing 1 changed file with 18 additions and 11 deletions.
29 changes: 18 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,37 +4,44 @@ A repository for [Open Data Hub](https://opendatahub.io) components Kustomize ma
## Community

* Website: https://opendatahub.io
* Documentation: https://opendatahub.io/docs.html
* Mailing lists: https://opendatahub.io/community.html
* Community meetings: https://gitlab.com/opendatahub/opendatahub-community
* Documentation: https://opendatahub.io/docs/
* ODH Community: https://opendatahub.io/community/

## ODH Core Components

Open Data Hub is an end-to-end AI/ML platform on top of OpenShift Container Platform that provides a core set of integrated components to support end end-to-end MLOps workflow for Data Scientists and Engineers. The components currently available as part of the ODH Core deployment are:

* [ODH Dashboard](odh-dashboard/README.md)
* [ODH Dashboard](https://github.com/opendatahub-io/odh-dashboard)
* [ODH Notebook Controller](odh-notebook-controller/README.md)
* [ODH Notebook Images](https://github.com/opendatahub-io/notebooks/blob/main/README.md)
* [ModelMesh](model-mesh/README.md)
* [TrustyAI Explainability](https://github.com/trustyai-explainability)

## ODH Incubating Components
* [Distributed Workloads](https://github.com/opendatahub-io/distributed-workloads)
* [Code Flare](https://github.com/project-codeflare)
* [ODH Notebook Images](https://github.com/opendatahub-io/odh-manifests/tree/master/notebook-images/overlays/additional)
* Elyra Notebook
* Code Server Notebook
* R Studio Notebook (CPU & CUDA)

Any components that were removed with the update to ODH 1.4 have been relocated to the [ODH Contrib](https://github.com/opendatahub-io-contrib) organization under the [odh-contrib-manifests](https://github.com/opendatahub-io-contrib/odh-contrib-manifests) repo. You can reference the [odh-contrib kfdef](kfdef/odh-contrib.yaml) as a reference on how to deploy any of the odh-contrib-manifests components

### Component Versions

| Manifest Version | ODH Dashboard | ODH Notebook Controller | ODH Notebook Images | Data Science Pipelines | ModelMesh |
| ---------------- | ------------- | ----------------------- | ------------------- |----------------------- | --------- |
| master | v2.11.0 | v1.6 | v1.3.1 | v1.2.1 | v0.9.0 |
| v1.4.1 | v2.5.2 | v1.6 | v1.3.1 | v1.2.1 | v0.9.0 |
| v1.4.0 | v2.2.1 | v1.6 | N/A | v1.2.1 | v0.9.0 |
| master | v2.11.0 | v1.6 | 2023a | v0.2.2 | v0.11.0 |

Release notes and component versions for each ODH release is available on [opendatahub.io](https://opendatahub.io/blog/?type=release)

## Deploy

We are relying on [Kustomize v3](https://github.com/kubernetes-sigs/kustomize), [kfctl](https://github.com/kubeflow/kfctl) and [Open Data Hub Operator](https://github.com/opendatahub-io/opendatahub-operator/blob/master/operator.md) for deployment.
We are relying on [Kustomize v3](https://github.com/kubernetes-sigs/kustomize), [kfctl](https://github.com/kubeflow/kfctl) and [Open Data Hub Operator](https://github.com/opendatahub-io/opendatahub-operator/blob/master/README.md) for deployment.

The two ways to deploy are:

1. Following [Getting Started](http://opendatahub.io/docs/getting-started/quick-installation.html) guide using a KFDef from this repository as the custom resource.
1. Using `kfctl` and follow the documentation at [Kubeflow.org](https://www.kubeflow.org/docs/openshift/). The only change is to use this repository instead of Kubeflow manifests.
1. Following [Getting Started](https://opendatahub.io/docs/quick-installation/) guide using a KFDef from this repository as the custom resource.

## Issues
To submit issues please file a GitHub issue in [odh-manifests](https://github.com/opendatahub-io/odh-manifests/issues)
To submit issues please file a GitHub issue in [opendatahub-community](https://github.com/opendatahub-io/opendatahub-community/issues)

0 comments on commit 30a393f

Please sign in to comment.