Update InPlacePodVerticalScaling docs for v1.33 beta #50290

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.

Sign up for GitHub

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

Jump to bottom

Merged

k8s-ci-robot merged 12 commits into kubernetes:dev-1.33 from tallclair:ippr-beta

Apr 7, 2025

Member

tallclair commented Mar 28, 2025 •

edited

Loading

Description

InPlacePodVerticalScaling is graduating to beta in v1.33. I rewrote the primary doc page to capture v1.33 changes and hopefully generally add clarity and detail.

Issue

Fixes #50022

/sig node
/priority important-soon
/milestone v1.33

Contributor

k8s-ci-robot commented Mar 28, 2025

@tallclair: You must be a member of the kubernetes/website-milestone-maintainers GitHub team to set the milestone. If you believe you should be able to issue the /milestone command, please contact your Website milestone maintainers and have them propose you as an additional delegate for this responsibility.

In response to this:

Description

InPlacePodVerticalScaling is graduating to beta in v1.33. I rewrote the primary doc page to capture v1.33 changes and hopefully generally add clarity and detail.

I plan to add more references to in-place resizing to other relevant pages (see #50022) in a separate PR.

Issue

Part of #50022

/sig node
/priority important-soon
/milestone v1.33

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-sigs/prow repository.

k8s-ci-robot added sig/node priority/important-soon labels

github-project-automation bot added this to SIG Node: code and documentation PRs

github-project-automation bot moved this to Triage in SIG Node: code and documentation PRs

k8s-ci-robot added language/en cncf-cla: yes size/L labels

k8s-ci-robot requested review from kbhawkey and shannonxtreme

March 28, 2025 04:36

netlify bot commented Mar 28, 2025 •

edited

Loading

👷 Deploy Preview for kubernetes-io-vnext-staging processing.

Name	Link
🔨 Latest commit	`9cce97a`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/67f31ef205562100087a0dc0

Member Author

tallclair commented Mar 28, 2025

/assign @natasha41575
/cc @sftim

k8s-ci-robot assigned natasha41575

k8s-ci-robot requested a review from sftim

March 28, 2025 04:37

netlify bot commented Mar 28, 2025 •

edited

Loading

✅ Pull request preview available for checking

Name	Link
🔨 Latest commit	`9cce97a`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/67f31ef27c1cd90008148e9a
😎 Deploy Preview	https://deploy-preview-50290--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

sftim suggested changes

View reviewed changes

Contributor

sftim left a comment

Thanks for the PR. I'm afraid we need a wider change, given the graduation to beta.

We must also update the Pod documentation at https://kubernetes.io/docs/concepts/workloads/pods/

For beta, and given that this will be enabled by default, I judge that revising the Pod concept docs is a requirement.

content/en/docs/tasks/configure-pod-container/resize-container-resources.md Outdated Show resolved Hide resolved

content/en/docs/tasks/configure-pod-container/resize-container-resources.md Show resolved Hide resolved

content/en/docs/tasks/configure-pod-container/resize-container-resources.md Outdated Show resolved Hide resolved

content/en/docs/tasks/configure-pod-container/resize-container-resources.md Outdated Show resolved Hide resolved

content/en/docs/tasks/configure-pod-container/resize-container-resources.md Outdated

    
              Below example shows a Pod whose Container's CPU can be resized without restart, but

              resizing memory requires the container to be restarted.

              You can control whether a container should be restarted when resizing by setting `resizePolicy` within the container specification. This allows fine-grained control based on resource type (CPU or memory).

Contributor

sftim Mar 28, 2025

What about extended resources (eg from device plugins)? The docs should make the story clear for those.

Member Author

tallclair Mar 28, 2025

This is covered under key-concepts (only CPU & Memory are mutable) and limitations. Do you have any suggestions of how to raise the visibility of this?

content/en/docs/tasks/configure-pod-container/resize-container-resources.md Outdated

    
              * **Resource Removal:** Resource requests and limits cannot be entirely removed once set; they can only be changed to different values.

              * **Operating System:** Windows pods do not support in-place resize.

              * **Node Policies:** Pods managed by [static CPU or Memory manager policies](/docs/tasks/administer-cluster/cpu-management-policies/) cannot be resized in-place.

              * **Swap:** Pods utilizing [swap memory](/docs/concepts/architecture/nodes/#swap-memory) cannot resize memory requests unless the `resizePolicy` for memory is `RestartContainer`.

Contributor

sftim Mar 28, 2025

Is this true?

Suggested change

      
            * **Swap:** Pods utilizing [swap memory](/docs/concepts/architecture/nodes/#swap-memory) cannot resize memory requests unless the `resizePolicy` for memory is `RestartContainer`.
          
            * **Swap:** Pods utilizing [swap memory](/docs/concepts/architecture/nodes/#swap-memory) can only resize memory requests if the `resizePolicy` for memory is `RestartContainer`. If the `resizePolicy` is set to something else, the API server accepts the resize request but it will not succeed.

Member Author

tallclair Mar 28, 2025

Again, do you think it's necessary to describe the enforcement mechanism here? Here's the full list:

Enforced in API admission:

Resource type
QoS class
Container types
Windows pods (only if OS name is windows)
Resource removal

Enforced at allocation time (resize marked Infeasible):

Static CPU / memory
Swap
node Capacity (not listed here)
Windows (anything that slipped through admission)

content/en/docs/tasks/configure-pod-container/resize-container-resources.md

    
              ## Example 1: Resizing CPU without Restart

              ## Create a pod with resource requests and limits

              First, create a Pod designed for in-place CPU resize and restart-required memory resize.

Contributor

sftim Mar 28, 2025

What namespace is this Pod in? Do you need to create a namespace first?

Member Author

tallclair Mar 28, 2025

I was thinking they could just use the default namespace, since it's just a single resource being created. Is it standard practice to create a dedicated namespace for all tutorials?

content/en/docs/tasks/configure-pod-container/resize-container-resources.md

    
              ```shell

              kubectl get pod qos-demo-5 --output=yaml --namespace=qos-example

              kubectl patch pod resize-demo --subresource resize --patch \

Contributor

sftim Mar 28, 2025

What namespace is change happening in? Do you need to create a namespace first?

Member Author

tallclair Mar 28, 2025

(see above)

content/en/docs/tasks/configure-pod-container/resize-container-resources.md Outdated Show resolved Hide resolved

content/en/docs/tasks/configure-pod-container/resize-container-resources.md

    
              Delete the pod:

              ```shell

              kubectl delete namespace qos-example

Contributor

sftim Mar 28, 2025

Does the namespace need removing or not?

github-project-automation bot moved this from Triage to Waiting on Author in SIG Node: code and documentation PRs

Contributor

sftim commented Mar 28, 2025

@tallclair if you want to bring in another contributor to work on some of these docs, that's fine; it doesn't have to all land on you.

Contributor

sftim commented Mar 28, 2025

/milestone 1.33

sftim added this to the 1.33 milestone

Contributor

sftim commented Mar 28, 2025

Actually, we can hold this PR whilst we get the Pod concept changes prepared and then unhold all the related PRs once it's clear that the docs will be ready.

@tallclair would you prefer that?

Contributor

natasha41575 commented Mar 28, 2025

/lgtm
for the content

k8s-ci-robot added the lgtm label

Contributor

k8s-ci-robot commented Mar 28, 2025

LGTM label has been added.

Git tree hash: ed1d44ec9aaa194d56a02393fc0f8d4c022438c4

k8s-ci-robot removed the lgtm label

k8s-ci-robot requested a review from natasha41575

March 28, 2025 17:08

tallclair force-pushed the ippr-beta branch from 49c7cf2 to 0b0b972 Compare

March 29, 2025 02:23

Member Author

tallclair commented Mar 29, 2025

I decided to just add the auxilary pages to this PR.

/assign @sftim

k8s-ci-robot assigned sftim

tallclair mentioned this pull request

1287: placeholder for 1.33 in place KEP update #49947

Closed

tallclair added 3 commits

April 6, 2025 11:44


          Cross-reference resource resizing from CPU & memory assignment tasks

4c183dc


          Add note about resizing to the downward API reference

4adfb87


          Update VPA in-place resizing section

bdec953

tallclair force-pushed the ippr-beta branch from 0b0b972 to bdec953 Compare

April 6, 2025 18:45

Member Author

tallclair commented Apr 6, 2025

Thanks for the review @vinaykul !

Member Author

tallclair commented Apr 6, 2025

/assign @vinaykul

k8s-ci-robot assigned vinaykul

vinaykul approved these changes

View reviewed changes

Member

vinaykul left a comment

/lgtm

k8s-ci-robot added the lgtm label

Contributor

k8s-ci-robot commented Apr 6, 2025

LGTM label has been added.

Git tree hash: a3ea774aa818bd5beeba4aba152c50030208bf54


          Update _index.md

a9271ca

k8s-ci-robot removed the lgtm label

k8s-ci-robot requested review from sftim and vinaykul

April 6, 2025 22:44

tengqm added 5 commits

April 7, 2025 06:45


          Update downward-api.md

85952fa


          Update InPlacePodVerticalScaling.md

8a49b3e


          Update kubelet-files.md

3373ac9


          Update resize-container-resources.md

12d533e


          Update autoscaling.md

9cce97a

tengqm added the tide/merge-method-squash label

Contributor

tengqm commented Apr 7, 2025

/approve

Contributor

k8s-ci-robot commented Apr 7, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: tengqm, vinaykul

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~content/en/OWNERS~~ [tengqm]

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 added the approved label

Member

rayandas commented Apr 7, 2025

@vinaykul Could you please give another lgtm? It got removed after a new commit. Thanks!

Member

vinaykul commented Apr 7, 2025

/lgtm

k8s-ci-robot added the lgtm label

Contributor

k8s-ci-robot commented Apr 7, 2025

LGTM label has been added.

Git tree hash: 43a8798ccc6541b76c15fe76ce55bb0156497766

k8s-ci-robot merged commit c014f72 into kubernetes:dev-1.33

6 checks passed

github-project-automation bot moved this from Waiting on Author to Done in SIG Node: code and documentation PRs

tallclair mentioned this pull request

In-Place Update of Pod Resources kubernetes/enhancements#1287

Open

97 tasks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

kbhawkey Awaiting requested review from kbhawkey

shannonxtreme Awaiting requested review from shannonxtreme

natasha41575 Awaiting requested review from natasha41575

sftim Awaiting requested review from sftim

vinaykul Awaiting requested review from vinaykul

Labels

approved cncf-cla: yes language/en lgtm priority/important-soon sig/node size/L tide/merge-method-squash