Training: Add documentation for the MultiKueue and spec.managedBy API

[Garvit-77]

This Documentation resolves :
kubeflow/training-operator/issues/2279

[google-oss-prow]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign andreyvelich for approval. For more information see the Kubernetes Code Review Process.

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

Needs approval from an approver in each of these files:

• content/en/docs/components/training/OWNERS

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

[google-oss-prow]

Hi @Garvit-77. Thanks for your PR.

I'm waiting for a kubeflow member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[Arhell]

/ok-to-test

[Garvit-77]

@andreyvelich please review the PR and let me know if any changes are expected

[andreyvelich]

Thank you for adding docs about managedBy APIs.
Please help us with the review
/assign @mimowo @mszadkow @kubeflow/wg-training-leads

[mimowo]

Please help us with the review
ack

[mimowo]

Actually, underneath Kueue will add a webhook which will default the field, so the example will not need to include it. I think we can just rely on the example eventually added to the MultiKueue documentation once kubernetes-sigs/kueue#2552 is done.

[mimowo]

WDYT @tenzen-y @andreyvelich ?

[andreyvelich]

Yes, I think we can reference to the example in Kueue docs, so we can be consistent.

[mimowo]

ok, I suggest to drop it in this PR so that we only have one place about the details. Note that the Kueue documentation is not added yet. Once done we will x-ref the pages.

[mimowo]

FYI, I think the feature will be almost completely a technical detail hidden from the users, as we are going to default the field in MultiKueue by a webhook once kubernetes-sigs/kueue#2552 is done. So, I think describing the field is ok, but eventually a "plain" TFJob is what the user yaml contains. So, I think we will be able to reference to the MultiKueue docs for example.

[mszadkow]

small adjustment spec.runPolicy.managedBy

[mimowo]

+1, in Kubeflow 1.9 this is under spec.runPolicy: https://github.com/kubeflow/trainer/blob/078ec30ff26649a07d2e28893c332d4cef70e233/pkg/apis/kubeflow.org/v1/common_types.go#L231C5-L239. Also adjust the code snippets to use

spec:
  runPolicy:
     managedBy: "kueue.x-k8s.io/multikueue"

[mimowo]

@andreyvelich the location of the field is changed between training-operator 1.9.0 and the new trainer. Trainer is still not supported though. Is this documentation page meant for 1.9.0 or the new trainer, or both? If both, should we add a note that the snippet presents the yaml only for training-operator 1.9.0?

[mimowo]

FYI we already have a note about this in Kueue in the MD file: https://github.com/kubernetes-sigs/kueue/blob/main/site/content/en/docs/tasks/run/multikueue/kubeflow.md. The actual user-facing documentation in https://kueue.sigs.k8s.io/docs/ link will be available when we release 0.11, which is planned for March 17th.

[andreyvelich]

he location of the field is changed between training-operator 1.9.0 and the new trainer. Trainer is still not supported though. Is this documentation page meant for 1.9.0 or the new trainer, or both? If both, should we add a note that the snippet presents the yaml only for training-operator 1.9.0?

These docs should be placed under legacy guide for Kubeflow Training Operator 1.9
https://www.kubeflow.org/docs/components/trainer/legacy-v1/user-guides/

@Garvit-77 Please can you rebase this PR, so you have the correct location for the guide.