Skip to content

Commit

Permalink
Few changes in README
Browse files Browse the repository at this point in the history
  • Loading branch information
andreyvelich committed Aug 4, 2021
1 parent 60e215b commit d206da5
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ Katib has these CRD examples in upstream:

- [Kubeflow `MPIJob`](https://www.kubeflow.org/docs/components/training/mpi/)

- [Tekton `Pipeline`](./examples/v1beta1/tekton)
- [Tekton `Pipelines`](./examples/v1beta1/tekton)

- [Argo `Workflows`](./examples/v1beta1/argo)

Expand Down
7 changes: 4 additions & 3 deletions examples/v1beta1/tekton/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,12 @@ tekton-pipelines-webhook-79d8f4f9bc-qmk97 1/1 Running 0 50s

**Note:** You must modify Tekton [`nop`](https://github.com/tektoncd/pipeline/tree/master/cmd/nop)
image to run Tekton Pipelines. `Nop` image is used to stop sidecar containers after main container
is completed. Metrics collector should not be stopped after training container is finished.
To avoid this problem, set `nop` image to metrics collector sidecar image.
is completed. Since Katib is using Metrics Collector sidecar container
and Tekton Pipelines controller should not kill sidecar containers, you have to
set this `nop` image to Metrics Collector image.

For example, if you are using
[StdOut](https://www.kubeflow.org/docs/components/katib/experiment/#metrics-collector) metrics collector,
[StdOut](https://www.kubeflow.org/docs/components/katib/experiment/#metrics-collector) Metrics Collector,
`nop` image must be equal to `docker.io/kubeflowkatib/file-metrics-collector`.

Run the following command to modify the `nop` image:
Expand Down

0 comments on commit d206da5

Please sign in to comment.