Skip to content

Commit b1dcd59

Browse files
committed
Update README with details on deploying optional components
1 parent 806e139 commit b1dcd59

File tree

1 file changed

+69
-1
lines changed

1 file changed

+69
-1
lines changed

README.md

Lines changed: 69 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,15 +197,83 @@ When a `DataSciencePipelinesApplication` is deployed, the following components a
197197
* APIServer
198198
* Persistence Agent
199199
* Scheduled Workflow controller
200-
* MLPipelines UI
201200

202201
If specified in the `DataSciencePipelinesApplication` resource, the following components may also be additionally deployed:
203202
* MariaDB
204203
* Minio
204+
* MLPipelines UI
205+
* MLMD (ML Metadata)
205206

206207
To understand how these components interact with each other please refer to the upstream
207208
[Kubeflow Pipelines Architectural Overview] documentation.
208209

210+
## Deploying Optional Components
211+
212+
### MariaDB
213+
To deploy a standalone MariaDB metadata database (rather than providing your own database connection details), simply add a `mariaDB` item under the `spec.database` in your DSPA definition with an `deploy` key set to `true`. All other fields are defaultable/optional, see [All Fields DSPA Example](./config/samples/dspa_all_fields.yaml) for full details. Note that this component is mutually exclusive with externally-provided databases (defined by `spec.database.externalDB`).
214+
215+
```
216+
apiVersion: datasciencepipelinesapplications.opendatahub.io/v1alpha1
217+
kind: DataSciencePipelinesApplication
218+
metadata:
219+
name: sample
220+
spec:
221+
...
222+
database:
223+
mariaDB: # mutually exclusive with externalDB
224+
deploy: true
225+
226+
```
227+
228+
### Minio
229+
To deploy a Minio Object Storage component (rather than providing your own object storage connection details), simply add a `minio` item under the `spec.objectStorage` in your DSPA definition with an `image` key set to a valid minio component container image. All other fields are defaultable/optional, see [All Fields DSPA Example](./config/samples/dspa_all_fields.yaml) for full details. Note that this component is mutually exclusive with externally-provided object stores (defined by `spec.objectStorage.externalStorage`).
230+
231+
```
232+
apiVersion: datasciencepipelinesapplications.opendatahub.io/v1alpha1
233+
kind: DataSciencePipelinesApplication
234+
metadata:
235+
name: sample
236+
spec:
237+
...
238+
objectStorage:
239+
minio: # mutually exclusive with externalStorage
240+
deploy: true
241+
# Image field is required
242+
image: 'quay.io/opendatahub/minio:RELEASE.2019-08-14T20-37-41Z-license-compliance'
243+
```
244+
245+
### ML Pipelines UI
246+
To deploy the standalone DS Pipelines UI component, simply add a `spec.mlpipelineUI` item to your DSPA with an `image` key set to a valid ui component container image. All other fields are defaultable/optional, see [All Fields DSPA Example](./config/samples/dspa_all_fields.yaml) for full details.
247+
248+
```
249+
apiVersion: datasciencepipelinesapplications.opendatahub.io/v1alpha1
250+
kind: DataSciencePipelinesApplication
251+
metadata:
252+
name: sample
253+
spec:
254+
...
255+
mlpipelineUI:
256+
deploy: true
257+
# Image field is required
258+
image: 'quay.io/opendatahub/odh-ml-pipelines-frontend-container:beta-ui'
259+
```
260+
261+
262+
### ML Metadata
263+
To deploy the ML Metadata artifact linage/metadata component, simply add a `spec.mlmd` item to your DSPA with `deploy` set to `true`. All other fields are defaultable/optional, see [All Fields DSPA Example](./config/samples/dspa_all_fields.yaml) for full details.
264+
265+
```
266+
apiVersion: datasciencepipelinesapplications.opendatahub.io/v1alpha1
267+
kind: DataSciencePipelinesApplication
268+
metadata:
269+
name: sample
270+
spec:
271+
...
272+
mlmd:
273+
deploy: true
274+
```
275+
276+
209277
# Using a DataSciencePipelinesApplication
210278

211279
When a `DataSciencePipelinesApplication` is deployed, use the MLPipelines UI endpoint to interact with DSP, either via a GUI or via API calls.

0 commit comments

Comments
 (0)