-
Notifications
You must be signed in to change notification settings - Fork 301
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
Revisit the documentation with respect to the concepts of Job and Workload #4286
Comments
I guess that we want to consider what is appropriate name instead of Jobs something like Task? Workload (this conflict with Workload API)? Application? |
cc @dgrove-oss |
I'm ok with Task, but would need to see how this presents itself in the docs. |
SGTM |
cc @PBundyra who is also looking into improvements for docs |
I agree that using something other than Job in the documentation as the generic name for the user-level "thing Kueue manages" is desirable. Job has a strong connotation of "batch job" and there is also the confusion between a generic I wish I could come up with a good synonym for workload that we weren't already using. Failing that, I do still think that overloading workload to mean both the user's notion of a workload and Kueue's Workload API object would still be an improvement. If we consistently said "Kueue Workload" for the later, that might be enough. |
/kind documentation
What would you like to be added:
Historically Kueue was only for "Jobs", so there was a clear 1:1 mapping between user's Job (and thus user's workload) and Kueue Workload API. This is no longer the case since:
To reflect that I would like to revisit the documentation, specifically:
Why is this needed:
To avoid confusions which has already been encountered a couple of times.
Completion requirements:
This enhancement requires the following artifacts:
The artifacts should be linked in subsequent comments.
The text was updated successfully, but these errors were encountered: