Skip to content

Commit 0a5c481

Browse files
committed
Add documentation
1 parent ac48810 commit 0a5c481

File tree

1 file changed

+35
-6
lines changed

1 file changed

+35
-6
lines changed
Lines changed: 35 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,39 @@
1-
# Description
1+
# Kubeflow CRDs
22

3-
# Kubernetes versions supported:
3+
This pack installs the Custom Resource Definitions for Kubeflow 1.9.1.
44

5-
# Constraints:
5+
## Prerequisites
66

7-
# Cloud types supported:
7+
None
88

9-
# References:
10-
-
9+
## Parameters
10+
11+
| **Parameter** | **Description** | **Type** | **Default Value** | **Required** |
12+
|---|---|---|---|---|
13+
| crds.minimized | Installs the minimum CRD schemas to pass validation. Set to `false` to install the full CRDs | Boolean | true | Yes |
14+
| notebooks.enabled | Installs the Notebooks CRD | Boolean | true | Yes |
15+
| notebooks.controller.enabled | Includes the controller in the Notebooks CRD | Boolean | true | Yes |
16+
| notebooks.controller.certManager.enabled | Includes cert-manager support for the controller in the Notebooks CRD | Boolean | false | Yes |
17+
| notebooks.controller.webhook.enabled | Includes webhook support for the controller in the Notebooks CRD | Boolean | false | Yes |
18+
| notebooks.pvcviewerController.enabled | Includes the pvcviewerController in the Notebooks CRD | Boolean | true | Yes |
19+
| profilesController.enabled | Installs the Profile CRD | Boolean | true | Yes |
20+
| katib.controller.enabled | Installs the Katib CRDs | Boolean | true | Yes |
21+
| pipelines.scheduledWorkflow.enabled | Installs the ScheduledWorkflow CRD | Boolean | true | Yes |
22+
| pipelines.viewerCrd.enabled | Installs the Viewer CRD | Boolean | true | Yes |
23+
| tensorboard.controller.enabled | Includes the Tensorboard CRD | Boolean | true | Yes |
24+
| trainingOperator.enabled | Installs the Training Operator v1 CRDs | Boolean | true | Yes |
25+
26+
27+
## Upgrade
28+
29+
This is the first version of the Kubeflow CRDs pack. There are no previous versions to upgrade from.
30+
31+
32+
## Usage
33+
34+
To deploy this pack, add it to your cluster profile. The defaults should not need adjusting.
35+
36+
37+
## References
38+
39+
- [Based on kromanow94/kubeflow-manifests](https://github.com/kromanow94/kubeflow-manifests/tree/helmcharts/charts/kubeflow-crds)

0 commit comments

Comments
 (0)