Skip to content

Commit d5a4525

Browse files
Jerry-yzShashank Mittal
authored andcommitted
fix katib use crds token pipeline trail template guide (kubeflow#2330)
Signed-off-by: Jerry-yz <[email protected]>
1 parent 48b4cec commit d5a4525

File tree

1 file changed

+10
-19
lines changed

1 file changed

+10
-19
lines changed

examples/v1beta1/tekton/README.md

Lines changed: 10 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -84,30 +84,21 @@ kubectl patch ClusterRole katib-controller -n kubeflow --type=json \
8484
-p='[{"op": "add", "path": "/rules/-", "value": {"apiGroups":["tekton.dev"],"resources":["pipelineruns", "taskruns"],"verbs":["get", "list", "watch", "create", "delete"]}}]'
8585
```
8686
87-
In addition to that, you have to modify Katib
88-
[Controller args](https://github.com/kubeflow/katib/blob/master/manifests/v1beta1/components/controller/controller.yaml#L27)
89-
with the new flag `--trial-resources`.
87+
Modify Katib Config [controller parameters](https://github.com/kubeflow/katib/blob/fc858d15dd41ff69166a2020efa200199063f9ba/manifests/v1beta1/installs/katib-standalone/katib-config.yaml#L9-L15) with the new entity:
9088
91-
Run the following command to update Katib Controller args:
92-
93-
```bash
94-
kubectl patch Deployment katib-controller -n kubeflow --type=json \
95-
-p='[{"op": "add", "path": "/spec/template/spec/containers/0/args/-", "value": "--trial-resources=PipelineRun.v1beta1.tekton.dev"}]'
89+
```
90+
trialResources:
91+
- <object-kind>.<object-API-version>.<object-API-group>
9692
```
9793
98-
Check that Katib Controller's pod was restarted:
99-
100-
```bash
101-
$ kubectl get pods -n kubeflow
94+
For example, to support Tekton Pipelines:
10295
103-
NAME READY STATUS RESTARTS AGE
104-
katib-controller-784994d449-9bgj9 1/1 Running 0 28s
105-
katib-db-manager-78697c7bd4-ck7l8 1/1 Running 0 6m13s
106-
katib-mysql-854cdb87c4-krcm9 1/1 Running 0 6m13s
107-
katib-ui-57b9d7f6dd-cv6gn 1/1 Running 0 6m13s
96+
```
97+
trialResources:
98+
- PipelineRun.v1beta1.tekton.dev
10899
```
109100
110-
Check logs from Katib Controller to verify Tekton Pipelines integration:
101+
After these changes, deploy Katib as described in the [install guide](https://www.kubeflow.org/docs/components/katib/installation/) and wait until the katib-controller Pod is created. You can check logs from the Katib controller to verify your resource integration:
111102
112103
```bash
113104
$ kubectl logs $(kubectl get pods -n kubeflow -o name | grep katib-controller) -n kubeflow | grep '"CRD Kind":"PipelineRun"'
@@ -118,4 +109,4 @@ $ kubectl logs $(kubectl get pods -n kubeflow -o name | grep katib-controller) -
118109
If you ran the above steps successfully, you should be able to run Tekton Pipelines examples.
119110

120111
Learn more about using custom Kubernetes resource as a Trial template in the
121-
[official Kubeflow guides](https://www.kubeflow.org/docs/components/katib/trial-template/#use-custom-kubernetes-resource-as-a-trial-template).
112+
[official Kubeflow guides](https://www.kubeflow.org/docs/components/katib/user-guides/trial-template/#use-crds-with-trial-template).

0 commit comments

Comments
 (0)