Quick Installation
Pre-requisites
Installing Open Data Hub requires OpenShift Container Platform version 4.8+. All screenshots and instructions are from OpenShift 4.10. For the purposes of this quick start, we used try.openshift.com on AWS. Tutorials will require an OpenShift cluster with a minimum of 16 CPUS and 32GB of memory across all OpenShift worker nodes.
Installing the Open Data Hub Operator
The Open Data Hub operator is available for deployment in the OpenShift OperatorHub as a Community Operators. You can install it from the OpenShift web console by following the steps below:
- From the OpenShift web console, log in as a user with
cluster-admin
privileges. For a developer installation from try.openshift.com, thekubeadmin
user will work. - Create a new namespace named ‘odh’ for your installation of Open Data Hub.
- Find
Open Data Hub
in theOperatorHub
catalog.- Select the new namespace if not already selected.
- Under
Operators
, selectOperatorHub
for a list of operators available for deployment. - Filter for
Open Data Hub
or look underAI/Machine Learning
for the icon forOpen Data Hub
.
- Click the
Install
button and follow the installation instructions to install the Open Data Hub operator. - The subscription creation view will offer a few options including Update Channel, keep the
rolling
channel selected. - It is important to switch to the namespace you created earlier. Installing in the “OpenShift Operators” namespace will result in a fatal error similar to “csv created in namespace with multiple operatorgroups, can’t pick one automatically”.
- To view the status of the Open Data Hub operator installation, find the Open Data Hub Operator under
Operators
->Installed Operators
(inside the namespace you created earlier). Once the STATUS field displaysInstallSucceeded
, you can proceed to create a new Open Data Hub deployment.
Create a New Open Data Hub Deployment
The Open Data Hub operator will create new Open Data Hub deployments and manage its components. Let’s create a new Open Data Hub deployment.
-
Find the Open Data Hub Operator under
Installed Operators
(inside the namespace you created earlier) -
Click on the Open Data Hub Operator to bring up the details for the version that is currently installed.
-
Click
Create Instance
to create a new deployment. -
Select the
YAML View
radio button to be presented with a YAML file to customize your deployment. Most of the components available in ODH have been removed, and for this tutorial we’ll leave them that way to make sure the components for JupyterHub and Spark fit within our cluster resource constraints.Take note of some parameters:
# ODH uses the KfDef manifest format to specify what components will be included in the deployment apiVersion: kfdef.apps.kubeflow.org/v1 kind: KfDef metadata: # The name of your kfdef object in OpenShift name: opendatahub # only the components listed in the `KFDef` resource will be deployed: spec: applications: # REQUIRED: This contains all of the common options used by all ODH components - kustomizeConfig: repoRef: name: manifests path: odh-common name: odh-common # Deploy ODH Dashboard w/ authentication enabled - kustomizeConfig: overlays: - authentication repoRef: name: manifests path: odh-dashboard name: odh-dashboard # Deploy ODH Notebook Controller - kustomizeConfig: repoRef: name: manifests path: odh-notebook-controller name: odh-notebook-controller # Deploy addtional Open Data Hub Jupyter notebooks - kustomizeConfig: overlays: - additional repoRef: name: manifests path: jupyterhub/notebook-images name: notebook-images # Deploy Model Mesh - kustomizeConfig: overlays: - odh-model-controller repoRef: name: manifests path: model-mesh name: model-mesh # Deploy Data Science Pipeline w/ standalone UI - kustomizeConfig: overlays: - metadata-store-mariadb - ds-pipeline-ui - object-store-minio - default-configs repoRef: name: manifests path: data-science-pipelines name: data-science-pipelines # Reference to all of the git repo archives that contain component kustomize manifests repos: # Official Open Data Hub v1.4 component manifests repo # This shows that we will be deploying components from an archive of the odh-manifests repo tagged for v1.4.0 - name: manifests uri: 'https://github.com/opendatahub-io/odh-manifests/tarball/v1.4'
-
Update the
spec
of the resource to match the above and clickCreate
. If you accepted the default name, this will trigger the creation of an Open Data Hub kfdef object namedopendatahub
and start the rollout of the ODH Core components. -
Verify the installation by viewing the Open Data Hub tab within the operator details. You Should see
opendatahub
listed. -
Verify the installation by viewing the project workload. The ODH Core components should be running.