Update Istio sidecar annotation information for the Katib experiments #2320

andreyvelich · 2020-10-28T19:44:56Z

Fixes: kubeflow/katib#1359.
Blocked by: #2312.

In the v1beta1 Katib version user should manually add sidecar.istio.io/inject: "false" to Experiment's Trial templates.

/assign @gaocegege @johnugeorge
/cc @RFMVasconcelos @8bitmp3

kubeflow-bot · 2020-10-28T19:45:05Z

This change is

8bitmp3

A few suggestions. Thank you @andreyvelich

8bitmp3 · 2020-11-02T22:39:10Z

content/en/docs/components/hyperparameter-tuning/experiment.md

+  [Istio sidecar injection](https://istio.io/latest/docs/setup/additional-setup/sidecar-injection/#automatic-sidecar-injection).
+  If you installed Kubeflow using [Istio config](https://www.kubeflow.org/docs/started/k8s/kfctl-k8s-istio/),
+  you have to disable sidecar injection. To do that, specify annotation `sidecar.istio.io/inject: "false"`
+  in experiment's trial template. See how to do it for `Job`, `TFJob` or `PyTorchJob` in


Suggestion:

Suggested change

in experiment's trial template. See how to do it for `Job`, `TFJob` or `PyTorchJob` in

in your experiment's trial template. For examples on how to do it for `Job`, `TFJob` (TensorFlow) or `PyTorchJob` (PyTorch), refer to the

8bitmp3 · 2020-11-02T22:39:50Z

content/en/docs/components/hyperparameter-tuning/experiment.md

@@ -670,8 +670,18 @@ to launch an experiment from the command line:
 kubectl apply -f <your-path/your-experiment-config.yaml>
 ```

-For example, run the following command to launch an experiment using the
-random algorithm example:
+**Note that**:


Suggestion:

Suggested change

**Note that**:

**Note**:

8bitmp3 · 2020-11-02T22:40:13Z

content/en/docs/components/hyperparameter-tuning/experiment.md

-random algorithm example:
+**Note that**:
+
+- If you deployed Katib as part of Kubeflow, you have to change Kubeflow namespace to your profile namespace.


Suggested change

- If you deployed Katib as part of Kubeflow, you have to change Kubeflow namespace to your profile namespace.

- If you deploy Katib as part of Kubeflow, you have to change the Kubeflow namespace to your profile namespace.

8bitmp3 · 2020-11-02T22:40:29Z

content/en/docs/components/hyperparameter-tuning/experiment.md

+
+- (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 installed Kubeflow using [Istio config](https://www.kubeflow.org/docs/started/k8s/kfctl-k8s-istio/),


Suggested change

If you installed Kubeflow using [Istio config](https://www.kubeflow.org/docs/started/k8s/kfctl-k8s-istio/),

If you install Kubeflow using [Istio config](https://www.kubeflow.org/docs/started/k8s/kfctl-k8s-istio/),

8bitmp3 · 2020-11-02T22:41:18Z

content/en/docs/components/hyperparameter-tuning/experiment.md

+  in experiment's trial template. See how to do it for `Job`, `TFJob` or `PyTorchJob` in
+  [getting-started guide](http://localhost:1313/docs/components/hyperparameter-tuning/hyperparameter/#examples).
+
+Run the following command to launch an experiment using the random algorithm example:

 ```


@andreyvelich If you have time, can you please add shell to three backticks whenever you see code blocks for command line examples? If you don't have time, don't worry. Thanks!

Suggested change

```

```shell

@andreyvelich If you have time, can you please add shell to three backticks whenever you see code blocks for command line examples? If you don't have time, don't worry. Thanks!

Sure, I'll do it in #2312. Thanks!

andreyvelich

@8bitmp3 Thank you for the review!
Your comments are addressed.

8bitmp3 · 2020-11-03T00:20:27Z

content/en/docs/components/hyperparameter-tuning/hyperparameter.md

+   [`.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](https://www.kubeflow.org/docs/components/training/tftraining/#what-is-tfjob) how to set annotation.
+
 1. Deploy the example:
    ```


Thank you @andreyvelich One more thing - again, if you have time - can you add blank lines that separate code blocks and text paragraphs here and elsewhere (e.g. lines 327, 337)

Suggested change

```

```shell

Appreciate it.

/assign @gaocegege @johnugeorge @sperlingxx

(OWNERS/approvers other than @andreyvelich 👍)

k8s-ci-robot · 2020-11-11T13:48:15Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: andreyvelich

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~content/en/docs/components/katib/OWNERS~~ [andreyvelich]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

andreyvelich · 2020-11-11T13:50:43Z

This PR is ready.
/cc @8bitmp3 @gaocegege @johnugeorge

gaocegege

LGTM 👍
/lgtm

k8s-ci-robot assigned gaocegege Oct 28, 2020

k8s-ci-robot added the do-not-merge/work-in-progress label Oct 28, 2020

k8s-ci-robot assigned johnugeorge Oct 28, 2020

k8s-ci-robot requested review from 8bitmp3 and rui-vas October 28, 2020 19:44

k8s-ci-robot added approved size/M labels Oct 28, 2020

andreyvelich mentioned this pull request Oct 30, 2020

Kubeflow 1.2 release doc changes #2322

Closed

8bitmp3 reviewed Nov 2, 2020

View reviewed changes

andreyvelich commented Nov 3, 2020

View reviewed changes

8bitmp3 reviewed Nov 3, 2020

View reviewed changes

k8s-ci-robot assigned sperlingxx Nov 3, 2020

andreyvelich mentioned this pull request Nov 3, 2020

Allow istio sidecar injection to trial pods kubeflow/katib#1374

Closed

andreyvelich added 5 commits November 11, 2020 13:34

Add istio sidecar annotation inforation

a5321ea

Address review comments

daa3c28

Should be your experiment

bc352d6

Annotation step after changing namespace

cd7f36f

Fix links

d406cc6

andreyvelich force-pushed the issue-1359-istio-sidecar-info branch from 4f511a1 to d406cc6 Compare November 11, 2020 13:48

andreyvelich changed the title ~~[WIP] Update Istio sidecar annotation information for the Katib experiments~~ Update Istio sidecar annotation information for the Katib experiments Nov 11, 2020

k8s-ci-robot removed the do-not-merge/work-in-progress label Nov 11, 2020

k8s-ci-robot requested review from 8bitmp3, gaocegege and johnugeorge November 11, 2020 13:50

gaocegege reviewed Nov 13, 2020

View reviewed changes

k8s-ci-robot added the lgtm label Nov 13, 2020

k8s-ci-robot merged commit 5cdf8e8 into kubeflow:master Nov 13, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Istio sidecar annotation information for the Katib experiments #2320

Update Istio sidecar annotation information for the Katib experiments #2320

andreyvelich commented Oct 28, 2020

kubeflow-bot commented Oct 28, 2020

8bitmp3 left a comment

8bitmp3 Nov 2, 2020

8bitmp3 Nov 2, 2020

8bitmp3 Nov 2, 2020

8bitmp3 Nov 2, 2020

8bitmp3 Nov 2, 2020

andreyvelich Nov 3, 2020 •

edited

Loading

andreyvelich left a comment

8bitmp3 Nov 3, 2020

k8s-ci-robot commented Nov 11, 2020

andreyvelich commented Nov 11, 2020

gaocegege left a comment

	in experiment's trial template. See how to do it for `Job`, `TFJob` or `PyTorchJob` in
	in your experiment's trial template. For examples on how to do it for `Job`, `TFJob` (TensorFlow) or `PyTorchJob` (PyTorch), refer to the

	- If you deployed Katib as part of Kubeflow, you have to change Kubeflow namespace to your profile namespace.
	- If you deploy Katib as part of Kubeflow, you have to change the Kubeflow namespace to your profile namespace.

	If you installed Kubeflow using [Istio config](https://www.kubeflow.org/docs/started/k8s/kfctl-k8s-istio/),
	If you install Kubeflow using [Istio config](https://www.kubeflow.org/docs/started/k8s/kfctl-k8s-istio/),

Update Istio sidecar annotation information for the Katib experiments #2320

Update Istio sidecar annotation information for the Katib experiments #2320

Conversation

andreyvelich commented Oct 28, 2020

kubeflow-bot commented Oct 28, 2020

8bitmp3 left a comment

Choose a reason for hiding this comment

8bitmp3 Nov 2, 2020

Choose a reason for hiding this comment

8bitmp3 Nov 2, 2020

Choose a reason for hiding this comment

8bitmp3 Nov 2, 2020

Choose a reason for hiding this comment

8bitmp3 Nov 2, 2020

Choose a reason for hiding this comment

8bitmp3 Nov 2, 2020

Choose a reason for hiding this comment

andreyvelich Nov 3, 2020 • edited Loading

Choose a reason for hiding this comment

andreyvelich left a comment

Choose a reason for hiding this comment

8bitmp3 Nov 3, 2020

Choose a reason for hiding this comment

k8s-ci-robot commented Nov 11, 2020

andreyvelich commented Nov 11, 2020

gaocegege left a comment

Choose a reason for hiding this comment

andreyvelich Nov 3, 2020 •

edited

Loading