diff --git a/content/en/docs/components/katib/experiment.md b/content/en/docs/components/katib/experiment.md index 7c68fd515f..787f5b9582 100644 --- a/content/en/docs/components/katib/experiment.md +++ b/content/en/docs/components/katib/experiment.md @@ -747,9 +747,23 @@ to launch an experiment from the command line: kubectl apply -f ``` -**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 diff --git a/content/en/docs/components/katib/hyperparameter.md b/content/en/docs/components/katib/hyperparameter.md index 3716353c1a..48f234efc7 100644 --- a/content/en/docs/components/katib/hyperparameter.md +++ b/content/en/docs/components/katib/hyperparameter.md @@ -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 @@ -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 @@ -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