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

Documentation for in-place pod resize feature #39845

Merged
merged 3 commits into from
Mar 31, 2023

Conversation

vinaykul
Copy link
Member

@vinaykul vinaykul commented Mar 7, 2023

Documentation for in-place pod resize feature. Ref: kubernetes/kubernetes#102884

@k8s-ci-robot k8s-ci-robot added this to the 1.27 milestone Mar 7, 2023
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. language/en Issues or PRs related to English language labels Mar 7, 2023
@k8s-ci-robot k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Mar 7, 2023
@vinaykul vinaykul force-pushed the dev-1.27 branch 2 times, most recently from bb7d86c to b893d8b Compare March 17, 2023 23:41
@vinaykul vinaykul changed the title Placeholder documentation for in-place pod resize feature Documentation for in-place pod resize feature Mar 17, 2023
@vinaykul
Copy link
Member Author

/assign @sftim

@vinaykul
Copy link
Member Author

@tengqm Thanks for the careful review, much appreciated! I fixed them (and hopefully didn't miss any of the items). PTAL.

@tengqm
Copy link
Contributor

tengqm commented Mar 20, 2023

/label tide/merge-method-squash
/lgtm

@k8s-ci-robot k8s-ci-robot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Mar 20, 2023
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 20, 2023
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 90754a44e41d00cec39a6c8ed1f0629e8c5b5bd9

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 20, 2023
@vinaykul
Copy link
Member Author

@tengqm I noticed a few missing things. Please review latest commit. thanks

@vinaykul vinaykul force-pushed the dev-1.27 branch 2 times, most recently from a1bc39f to e5ebc5a Compare March 20, 2023 19:32
@tengqm
Copy link
Contributor

tengqm commented Mar 21, 2023

@vinaykul Please try keep this PR at a single commit, i.e., please squash your commits into one.

@vinaykul vinaykul force-pushed the dev-1.27 branch 3 times, most recently from 2235f3c to d71d2e5 Compare March 21, 2023 03:58
Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. With a few tweaks this should be OK to merge.

Comment on lines 18 to 27
The following changes enable in-place resize of container resources:
- Container's resource **requests** and **limits** are now **mutable** for CPU
and memory resources.
- A new field named `allocatedResources` has been added to `containerStatuses`
in the Pod's status to reflect the resources allocated to the pod's containers.
- A new field named `resources` has been added to the Container's status. This
field reflects the actual resource requests and limits that are configured on
the running containers as reported by the container runtime.
- A new field named `resize` has been added to the Pod's status to show the
status of the last requested pending resize. It can have the following values:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Describe the current behavior, not the diff.


Consider the following manifest for a Pod that has one Container.

{{< codenew file="pods/qos/qos-pod.yaml" >}}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider making a new separate example manifest.

Comment on lines 22 to 23
- Container's resource **requests** and **limits** are now **mutable** for CPU
and memory resources.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a strong opinion, but I'd like to format bulletin items by having the following lines indented. For example:

Suggested change
- Container's resource **requests** and **limits** are now **mutable** for CPU
and memory resources.
- Container's resource **requests** and **limits** are now **mutable** for CPU
and memory resources.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

@tengqm
Copy link
Contributor

tengqm commented Mar 22, 2023

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: tengqm

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:

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 the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 22, 2023
vinaykul and others added 3 commits March 22, 2023 02:50
Fix issues from review feedback

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

Co-authored-by: Qiming Teng <tengqm@outlook.com>

Better wording and formatting of overview section

Add descriptions about allocatedResources, resources, and resize fields

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

Co-authored-by: Qiming Teng <tengqm@outlook.com>

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

Co-authored-by: Qiming Teng <tengqm@outlook.com>

Apply suggestions from code review

Co-authored-by: Qiming Teng <tengqm@outlook.com>
Co-authored-by: Tim Bannister <tim@scalefactory.com>
@vinaykul
Copy link
Member Author

vinaykul commented Mar 22, 2023

@sftim I fixed the issues you found. PTAL, thx

@vinaykul
Copy link
Member Author

@sftim Please take a look, I believe I have addressed all issues you found.

@tengqm
Copy link
Contributor

tengqm commented Mar 31, 2023

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 31, 2023
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 5b8e5b235780d8e07749df16f0d47cea7b0b497a

@k8s-ci-robot k8s-ci-robot merged commit a4eca1a into kubernetes:dev-1.27 Mar 31, 2023
DonatoHorn pushed a commit to DonatoHorn/website that referenced this pull request Jun 25, 2023
* Documentation for in-place pod resize feature

Fix issues from review feedback

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

Co-authored-by: Qiming Teng <tengqm@outlook.com>

Better wording and formatting of overview section

Add descriptions about allocatedResources, resources, and resize fields

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

Co-authored-by: Qiming Teng <tengqm@outlook.com>

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

Co-authored-by: Qiming Teng <tengqm@outlook.com>

Apply suggestions from code review

Co-authored-by: Qiming Teng <tengqm@outlook.com>

* Simplify the changes by using bullet points

* Apply suggestions from code review

Co-authored-by: Tim Bannister <tim@scalefactory.com>

---------

Co-authored-by: Qiming Teng <tengqm@outlook.com>
Co-authored-by: Tim Bannister <tim@scalefactory.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants