Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Istio sidecar annotation information for the Katib experiments #2320

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 17 additions & 3 deletions content/en/docs/components/katib/experiment.md
Original file line number Diff line number Diff line change
Expand Up @@ -716,9 +716,23 @@ to launch an experiment from the command line:
kubectl apply -f <your-path/your-experiment-config.yaml>
```

**Note:** If you deployed Katib as part of Kubeflow (your Kubeflow deployment
should include Katib), you need to change Kubeflow namespace to your
profile namespace. Run the following command to launch an experiment
**Note:**

- If you deployed Katib as part of Kubeflow (your Kubeflow deployment
should include Katib), you need to change Kubeflow namespace to your
profile namespace.

- (Optional) Katib's experiments don't work with
[Istio sidecar injection](https://istio.io/latest/docs/setup/additional-setup/sidecar-injection/#automatic-sidecar-injection).
If you install Kubeflow using
[Istio config](https://www.kubeflow.org/docs/started/k8s/kfctl-k8s-istio/),
you have to disable sidecar injection. To do that, specify this annotation:
`sidecar.istio.io/inject: "false"` in your experiment's trial template. For
examples on how to do it for `Job`, `TFJob` (TensorFlow) or
`PyTorchJob` (PyTorch), refer to the
[getting-started guide](/docs/components/katib/hyperparameter/#examples).

Run the following command to launch an experiment
using the random algorithm example:

```shell
Expand Down
34 changes: 34 additions & 0 deletions content/en/docs/components/katib/hyperparameter.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,21 @@ an experiment using the random algorithm example:
Namespace: kubeflow
```

1. (Optional) **Note:** Katib's experiments don't work with
[Istio sidecar injection](https://istio.io/latest/docs/setup/additional-setup/sidecar-injection/#automatic-sidecar-injection).
If you installed Kubeflow using
[Istio config](/docs/started/k8s/kfctl-k8s-istio/),
you have to disable sidecar injection. To do that, specify this annotation:
`sidecar.istio.io/inject: "false"` in your experiment's trial template.

For the provided random example with Kubernetes
[`Job`](https://kubernetes.io/docs/concepts/workloads/controllers/job/)
trial template, annotation should be under
[`.trialSpec.spec.template.metadata.annotations`](https://github.com/kubeflow/katib/blob/master/examples/v1beta1/random-example.yaml#L52).
For the Kubeflow `TFJob` or other training operators check
[here](/docs/components/training/tftraining/#what-is-tfjob)
how to set the annotation.

1. Deploy the example:

```shell
Expand Down Expand Up @@ -373,6 +388,16 @@ the Kubeflow's TensorFlow training job operator, TFJob:
Namespace: kubeflow
```

1. (Optional) **Note:** Katib's experiments don't work with
[Istio sidecar injection](https://istio.io/latest/docs/setup/additional-setup/sidecar-injection/#automatic-sidecar-injection).
If you installed Kubeflow using
[Istio config](/docs/started/k8s/kfctl-k8s-istio/),
you have to disable sidecar injection. To do that, specify this annotation:
`sidecar.istio.io/inject: "false"` in your experiment's trial template.
For the provided `TFJob` example check
[here](/docs/components/training/tftraining/#what-is-tfjob)
how to set the annotation.

1. Deploy the example:

```shell
Expand Down Expand Up @@ -407,6 +432,15 @@ using Kubeflow's PyTorch training job operator, PyTorchJob:
Namespace: kubeflow
```

1. (Optional) **Note:** Katib's experiments don't work with
[Istio sidecar injection](https://istio.io/latest/docs/setup/additional-setup/sidecar-injection/#automatic-sidecar-injection).
If you installed Kubeflow using
[Istio config](/docs/started/k8s/kfctl-k8s-istio/),
you have to disable sidecar injection. To do that, specify this annotation:
`sidecar.istio.io/inject: "false"` in your experiment's trial template.
For the provided `PyTorchJob` example setting the annotation should be similar to
[`TFJob`](/docs/components/training/tftraining/#what-is-tfjob)

1. Deploy the example:

```shell
Expand Down