Document ways to avoid users submitting workloads without any requests

kannon92 commented 1 month ago

What would you like to be added: We should add a doc to explain how to use ValidationAdmissionPolicy to optionally forbid users from submitting workloads without any requests.

This page should be updated to mention how one can use VAP to enforce workloads having requests.

Why is this needed:

Kueue tracks resource requests by the requests field in the PodTemplate. If one submits a workload without any requests specified, kueue will not report any resources used by this workload.

It would be worth mentioning this in the docs and provide an example to forbid this. Completion requirements:

This enhancement requires the following artifacts:

[ ] Design doc
[ ] API change
[x] Docs update

The artifacts should be linked in subsequent comments.

kannon92 commented 1 month ago

/remove-kind feature /kind docs /help /good-first-issue

k8s-ci-robot commented 1 month ago

@kannon92: This request has been marked as suitable for new contributors.

Guidelines

Please ensure that the issue body includes answers to the following questions:

Why are we solving this issue?
To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
Does this issue have zero to low barrier of entry?
How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed by commenting with the /remove-good-first-issue command.

In response to [this](https://github.com/kubernetes-sigs/kueue/issues/3069): >/remove-kind feature >/kind docs >/help >/good-first-issue Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.

k8s-ci-robot commented 1 month ago

@kannon92: The label(s) kind/docs cannot be applied, because the repository doesn't have them.

In response to [this](https://github.com/kubernetes-sigs/kueue/issues/3069#issuecomment-2353033563): >/remove-kind feature >/kind docs >/help >/good-first-issue Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.

tenzen-y commented 1 month ago

/kind documentation

amitmaurya07 commented 3 weeks ago

Hi, I would like to work on this issue. Could you please assign this issue to me?

mbobrovskyi commented 3 weeks ago

/assign @amitmaurya07

kubernetes-sigs / kueue

Document ways to avoid users submitting workloads without any requests #3069

Guidelines