[Discussion] The future of Trial metadata parameters.

[Electronic-Waste]

As we discuss in issue #2369 , we choose to always pass the Trial name as env variable KATIB_TRIAL_NAME to the training container. And we implemented this feature as function mutatePodEnv and used it here:

katib/pkg/webhook/v1beta1/pod/inject_webhook.go

Lines 140 to 142 in 206fe1c

	// Add Katib Trial labels to the Pod metadata.
	mutatePodMetadata(mutatedPod, trial)

Here are some discussions about it: #2369 (comment) #2369 (comment) #2369 (comment)

We use this issue to track the discussion. Any suggestions are welcome!

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[andreyvelich]

/remove-lifecycle stale
/good-first-issue

[mickvangelderen]

In my project I would like to know the experiment name and trial name:

KATIB_EXPERIMENT_NAME
KATIB_TRIAL_NAME

as these values may be generated by K8S.

It would be nice to also know the namespace:

KATIB_NAMESPACE

as well, even though that value may be known.

For my project, I also need

KATIB_BASE_URL

but I suppose Katib does not necessarily know it's external-facing base URL and so I can inject that value into the container envs myself.

I compute the experiment url and trial url from the base URL, namespace and names. If the URLs are not stable, we can consider also exposing the relative URLs of the experiment and trial:

KATIB_RELATIVE_EXPERIMENT_URL
KATIB_RELATIVE_TRIAL_URL

Not sure that's worth doing or how they should be named. Currently I am not sure how to construct the trial url though, see #2474.

[Electronic-Waste]

Could you please pin this issue so that more people can join the discussion? @andreyvelich
/remove-good-first-issue
/kind discussion

[Electronic-Waste]

I think it's a good idea to pass corresponding experiment name and the namespace to the env of Pod! As for the url, I'm not sure if we need to pass it to the pod.

WDYT👀 @kubeflow/wg-automl-leads @tariq-hasan @helenxie-bit

[andreyvelich]

We can get Kubernetes namespace from this location on Pod:

/var/run/secrets/kubernetes.io/serviceaccount/namespace

[Electronic-Waste]

@andreyvelich Oh, I see. Maybe we need to add the experiment name to the env of Pod. I'll raise a PR to address that.