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

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

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

Garvit-77
Copy link

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

Copy link

[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:

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

Copy link

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.

Copy link
Member

@Arhell Arhell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/ok-to-test

@Garvit-77
Copy link
Author

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

Copy link
Member

@andreyvelich andreyvelich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@andreyvelich andreyvelich changed the title resolves kubeflow/training-operator/issues/2279 Training: Add documentation for the MultiKueue and spec.managedBy API Jan 15, 2025
@mimowo
Copy link

mimowo commented Jan 23, 2025

Please help us with the review
ack

...
```

Example
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@mimowo
Copy link

mimowo commented Jan 23, 2025

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.

Garvit-77 and others added 5 commits January 24, 2025 01:39
Co-authored-by: Michał Woźniak <[email protected]>
Signed-off-by: Garvit Khandelwal <[email protected]>
Co-authored-by: Michał Woźniak <[email protected]>
Signed-off-by: Garvit Khandelwal <[email protected]>
Co-authored-by: Michał Woźniak <[email protected]>
Signed-off-by: Garvit Khandelwal <[email protected]>
Co-authored-by: Michał Woźniak <[email protected]>
Signed-off-by: Garvit Khandelwal <[email protected]>
Co-authored-by: Michał Woźniak <[email protected]>
Signed-off-by: Garvit Khandelwal <[email protected]>
Co-authored-by: Michał Woźniak <[email protected]>
Signed-off-by: Garvit Khandelwal <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants