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

Pod Resource API: Explicitly clarify the behavior of GetAllocatableResources endpoint #2761

Conversation

swatisehgal
Copy link
Contributor

The explanation that GetAllocatableResources can be used to obtain available resources
on the node can be misinterpretted as an API that is used to obtain free/unallocated
resources on a node.

This PR adds additional text to clarify that this API endpoint only returns
allocatable resources which are resources exposed to kubelet as defined here:
https://kubernetes.io/docs/tasks/administer-cluster/reserve-compute-resources/#node-allocatable.

Signed-off-by: Swati Sehgal [email protected]

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label May 20, 2021
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: swatisehgal
To complete the pull request process, please assign dchen1107 after the PR has been reviewed.
You can assign the PR to them by writing /assign @dchen1107 in a comment when ready.

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

@k8s-ci-robot k8s-ci-robot added kind/kep Categorizes KEP tracking issues and PRs modifying the KEP directory sig/node Categorizes an issue or PR as relevant to SIG Node. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels May 20, 2021
@swatisehgal swatisehgal changed the title Explicitly clarify the behavior of GetAllocatableResources Pod Resource API: Explicitly clarify the behavior of GetAllocatableResources endpoint May 20, 2021
@swatisehgal swatisehgal force-pushed the clarify-podsresource-getallocatable branch from 6f81fc1 to 8195d3b Compare May 20, 2021 23:48
@swatisehgal
Copy link
Contributor Author

/cc @fromanirh

@k8s-ci-robot k8s-ci-robot requested a review from ffromani May 24, 2021 08:52
The explanation that GetAllocatableResources can be used to obtain available resources
on the node can be misinterpretted as an API that is used to obtain free/unallocated
resources on a node.

This PR adds additional text to clarify that this API endpoint only returns
allocatable resources which are resources exposed to kubelet as defined here:
https://kubernetes.io/docs/tasks/administer-cluster/reserve-compute-resources/#node-allocatable.

Signed-off-by: Swati Sehgal <[email protected]>
@swatisehgal swatisehgal force-pushed the clarify-podsresource-getallocatable branch from 8195d3b to 6367aaf Compare May 26, 2021 15:33
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue or PR as fresh with /remove-lifecycle stale
  • Mark this issue or PR as rotten with /lifecycle rotten
  • Close this issue or PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Aug 24, 2021
@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Sep 8, 2021
@k8s-ci-robot
Copy link
Contributor

@swatisehgal: PR needs rebase.

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.

@k8s-ci-robot
Copy link
Contributor

@swatisehgal: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Rerun command
pull-enhancements-test 6367aaf link /test pull-enhancements-test

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

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. I understand the commands that are listed here.

@swatisehgal
Copy link
Contributor Author

This change was made as part of the graduation of the feature to Beta here: #2932 so closing this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/kep Categorizes KEP tracking issues and PRs modifying the KEP directory lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. sig/node Categorizes an issue or PR as relevant to SIG Node. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants