Skip to content

Commit 81c143b

Browse files
committed
Add Clarity to Manifests Installation Guide
1 parent e6126e9 commit 81c143b

File tree

1 file changed

+26
-6
lines changed

1 file changed

+26
-6
lines changed

manifests/opendatahub/README.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,41 @@ Data Science Pipelines is the Open Data Hub's pipeline solution for data scienti
77

88
### Prerequisites
99

10+
#### Requirements
1011
1. The cluster needs to be OpenShift 4.9 or higher
11-
2. OpenShift Pipelines 1.7.2 or higher needs to be installed on the cluster
12-
3. The Open Data Hub operator needs to be installed
13-
4. The default installation namespace for Data Science Pipelines is `odh-applications`. This namespace will need to be created. In case you wish to install in a custom location, create it and update the kfdef as documented below.
12+
2. The [oc client](https://mirror.openshift.com/pub/openshift-v4/x86_64/clients/ocp/latest/openshift-client-linux.tar.gz) is installed and you are logged into this cluster.
13+
3. The following Operators must be installed on the cluster. (See [How to Install an Operator](#installing-a-prerequisite-operator))
14+
* The Open Data Hub operator (See official [documentation](https://opendatahub.io/docs/getting-started/quick-installation.html)).
15+
* OpenShift Pipelines 1.7.2 or higher
16+
4. The default installation namespace for Data Science Pipelines is `odh-applications`. If it hasn't already, this namespace will need to be created (via `oc new-project odh-applications`). In case you wish to install in a custom location, create it and update the kfdef as documented below.
17+
18+
#### Installing a Prerequisite Operator
19+
The installation of Data Science Pipelines requires a few Operators to be installed as a prerequisite. Follow these steps to install an Operator from OperatorHub:
20+
21+
1. Log into the OpenShift Console web interface
22+
2. Ensure the "Administrator" view is active (rather than "Developer", visible on left-hand sidebar)
23+
3. Click the "Operators" sidebar menu item, then select the "OperatorHub" sub-item
24+
4. A list of all available operators will be shown. Use the search bar to filter for the one you're looking for (ie "OpenShift Pipelines" or "Open Data Hub")
25+
5. Click the tile for the Operator you'd like to install. A popup dialog/quickstart will be shown. Click "Install".
26+
6. Select installation parameters (such as Update Channel/Approval mode) when prompted. Typically, the default values are usually fine as-is.
27+
7. Click "Install". You will be brought to an installation progress page; wait a few minutes for installation to complete.
1428

1529
### Installation Steps
1630

1731
1. Ensure that the prerequisites are met.
18-
2. Apply the kfdef at [kfctl_openshift_ds-pipelines.yaml](https://github.com/opendatahub-io/odh-manifests/blob/master/kfdef/kfctl_openshift_ds-pipelines.yaml). You may need to update the `namespace` field under `metadata` in case you want to deploy in a namespace that isn't `odh-applications`.
19-
3. To find the url for Data Science pipelines, you can run the following command.
32+
2. Apply the kfdef at [kfctl_openshift_ds-pipelines.yaml](https://github.com/opendatahub-io/odh-manifests/blob/master/kfdef/kfctl_openshift_ds-pipelines.yaml) via `oc apply -n odh-applications -f kfctl_openshift_ds-pipelines.yaml`.
33+
34+
Note that you may need to update the `namespace` field under `metadata` in case you want to deploy in a namespace that isn't `odh-applications`.
35+
36+
### Accessing the UI
37+
* To find the url for Data Science pipelines, you can run the following command.
2038
```bash
2139
$ oc get route -n <kdef_namespace> ds-pipeline-ui -o jsonpath='{.spec.host}'
2240
```
2341
The value of `<kfdef_namespace>` should match the namespace field of the kfdef that you applied.
24-
4. Alternatively, you can access the route via the console. To do so:
42+
You may need to append the protocol to the route (ie `https://`), but this can otherwise be pasted into a browser to access the UI
43+
44+
* Alternatively, you can access the route via the console. To do so:
2545

2646
1. Go to `<kfdef_namespace>`
2747
2. Click on `Networking` in the sidebar on the left side.

0 commit comments

Comments
 (0)