ResourceList's Cpu() function claim to return "the CPU limit if specified" while returning the content of "cpu" instead of "limits.cpu"

[ArchangelX360]

What happened:

ResourceList's Cpu() function claim to return "the CPU limit if specified" while returning the content of ResourceName "cpu" instead of ResourceName "limits.cpu".

What you expected to happen:

I would expect Cpu() to return "limits.cpu" key content instead of "cpu" key content. Meaning using ResourceLimitsCPU ResourceName instead of ResourceCPU ResourceName.

It could be that the documentation of the function is invalid.

It seems as well that the confusion is coming from the fact that ResourceList struct is both used in the context of ResourceQuotaSpec but also in ResourceRequirements. Even though the manifest overall structure of these two is a little bit different.
Indeed, the information about wether the key is a limit or a request is fundamentally different in the two contexts:

• in ResourceQuotaSpec withing the ResourceList we need to prefix the keys by limits. or requests..
• while in ResourceRequirements, the manifest itself is declaring Limits and Requests being two different ResourceListss.

How to reproduce it (as minimally and precisely as possible):

Non relevant.

Anything else we need to know?:

This is linked to the issue reported on the (I assume) wrong issue board: kubernetes/api#31

Environment:

• Kubernetes version (use kubectl version): non relevant
• Cloud provider or hardware configuration: non relevant
• OS (e.g: cat /etc/os-release): non relevant
• Kernel (e.g. uname -a): non relevant
• Install tools: non relevant
• Network plugin and version (if this is a network-related bug): non relevant
• Others: non relevant

[ArchangelX360]

/sig api-machinery

[ZihanJiang96]

I could work on this issue if this is a valid bug @ArchangelX360

[fedebongio]

/sig node
in any case, if needs to be fixed it's going to be hard to make it backward compatible, so copying also the api reviewers label
/api-review

[fedebongio]

/label api-review

[fejta-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

[ArchangelX360]

/remove-lifecycle stale

[liggitt]

I would recommend:

• fixing the documentation to accurately describe what is returned ("returns the value of the cpu resource")
• sweeping in-tree uses to make sure we're only using it correctly

/remove-label api-review

[apoland]

I'm willing to fix documentation and audit the use of this function.

[apoland]

/assign

[fejta-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-contributor-experience at kubernetes/community.
/lifecycle stale

[fejta-bot]

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-contributor-experience at kubernetes/community.
/lifecycle rotten

[fejta-bot]

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-contributor-experience at kubernetes/community.
/close

[k8s-ci-robot]

@fejta-bot: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-contributor-experience at kubernetes/community.
/close

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.