Skip to content

Commit d9ee12b

Browse files
Merge pull request opendatahub-io#89 from HumairAK/odh-main-readme-update
Clarify readme.
2 parents de86917 + fbb020f commit d9ee12b

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,10 @@ echo https://$(oc get routes -n ${DSP_Namespace} ds-pipeline-ui-${DSP_CR_NAME} -
200200

201201
## Using the Graphical UI
202202

203+
> Note the UI presented below is the upstream Kubeflow Pipelines UI, this is not supported in DSP and will be replaced
204+
> with the ODH Dashboard UI. Until then, this UI can be deployed via DSPO for experimentation/development purposes.
205+
> Note however that this UI is not a supported feature of DSPO/ODH.
206+
203207
Navigate to the route retrieved in the last step. You will be presented with the MLPipelines UI. In this walkthrough we
204208
will upload a pipeline and start a run based off it.
205209

@@ -238,6 +242,9 @@ see these logs after clicking this step and navigating to "Logs."
238242

239243
## Using the API
240244

245+
> Note: By default we use kfp-tekton v1.4 for this section so you will need [kfp-tekton v1.4.x sdk installed][kfp-tekton]
246+
> in your environment
247+
241248
In the previous step we submitted a generated `Pipeline` yaml via the GUI. We can also submit the `Pipeline` code
242249
directly either locally or via a notebook.
243250

@@ -263,6 +270,17 @@ client = kfp_tekton.TektonClient(host=route, existing_token=token)
263270
client.create_run_from_pipeline_func(pipeline_func=flipcoin_pipeline, arguments={})
264271
```
265272

273+
> Note: If you are in an unsecured cluster, you may encounter `CERTIFICATE_VERIFY_FAILED` error, to work around this
274+
> you can pass in the self-signed certs to the kfp-tekton client. For instance, if running inside a notebook or pod
275+
> on the same cluster, you can do the following:
276+
277+
```python
278+
...
279+
cert = "/run/secrets/kubernetes.io/serviceaccount/ca.crt"
280+
client = kfp_tekton.TektonClient(host=route, existing_token=token, ssl_ca_cert=cert)
281+
client.create_run_from_pipeline_func(pipeline_func=flipcoin_pipeline, arguments={})
282+
```
283+
266284
Retrieve your token and DSP route:
267285

268286
```bash
@@ -349,3 +367,4 @@ without having to repeat these steps.
349367
[flipcoin example]: https://github.com/opendatahub-io/data-science-pipelines-operator/blob/main/docs/example_pipelines/condition.yaml
350368
[flipcoin code example]: https://github.com/opendatahub-io/data-science-pipelines-operator/blob/main/docs/example_pipelines/condition.py
351369
[installodh]: https://opendatahub.io/docs/getting-started/quick-installation.html
370+
[kfp-tekton]: https://github.com/kubeflow/kfp-tekton

0 commit comments

Comments
 (0)