Skip to content

Documentation for Swap memory management #51303

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

Merged
merged 5 commits into from
Jul 14, 2025

Conversation

iholder101
Copy link
Contributor

Description

Add documentation for KEP-2400 NodeSwap GA.

Basically, this PR does 2 things:

  1. Creates a new dedicated swap memory management documentation under content/en/docs/concepts/cluster-administration/swap-memory-management.md. This documentation is heavily based on the contents of the latest blog-post about swap memory: https://kubernetes.io/blog/2025/03/25/swap-linux-improvements/. While the content is very similar, there are minor updates.
  2. Removes the old very minimal swap documentation that existed under content/en/docs/concepts/architecture/nodes.md.

This documentation should contain everything the user needs to know for swap GA.

Issue

Fixes #51153

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jun 19, 2025
@k8s-ci-robot k8s-ci-robot requested review from dchen1107 and lmktfy June 19, 2025 11:21
@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jun 19, 2025
Copy link

netlify bot commented Jun 19, 2025

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit cbe99fe
🔍 Latest deploy log https://app.netlify.com/projects/kubernetes-io-main-staging/deploys/686fea1255056a0008de18a6
😎 Deploy Preview https://deploy-preview-51303--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@iholder101
Copy link
Contributor Author

/cc @ajaysundark

@k8s-ci-robot k8s-ci-robot requested a review from ajaysundark June 19, 2025 11:33
Copy link
Contributor

@lmktfy lmktfy left a comment

Choose a reason for hiding this comment

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

Thank you for working on this - it's really needed.

Here's quite a lot of feedback.

Copy link
Contributor

@lmktfy lmktfy left a comment

Choose a reason for hiding this comment

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

Partial feedback

@iholder101 iholder101 force-pushed the docs/swap-ga branch 5 times, most recently from 6a0b0d5 to bde09da Compare June 22, 2025 13:15
@ajaysundark
Copy link

I looked into it quick, I'll spend more time to continue review on this.

IMHO, the changes could add more structure for better flow. Admins are often in a hurry. The final document should be easy to scan for.
The official guide will benefit with more value with focus on 'configuration', 'monitoring' and 'troubleshooting' guide. Concepts and details need to be captured, but deep-dive shouldn't mix into configuration details. And I'm not sure on the preferences, but promotional or what to expect next details seem out of place on the official guide. I think you covered lots of these details at the blog post already.

@iholder101 iholder101 force-pushed the docs/swap-ga branch 2 times, most recently from 2a8bdec to ef22d32 Compare June 29, 2025 14:30
@iholder101
Copy link
Contributor Author

@ajaysundark thanks for the review! Appreciate it.

I believe your comments are addressed now. Can you please take another look?

@iholder101
Copy link
Contributor Author

Hey @lmktfy @ajaysundark!
Should I have pushed this PR to the dev-1.34 branch? Should I reopen the PR to do so?

@ajaysundark
Copy link

I think you probably can still edit the PR to change the destination branch as dev-1.34. Would need to rebase your original branch as well.

Copy link
Contributor

@kannon92 kannon92 left a comment

Choose a reason for hiding this comment

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

LGTM from node side.

maybe @haircommander would like to take a look also?

Signed-off-by: Itamar Holder <iholder@redhat.com>
Signed-off-by: Itamar Holder <iholder@redhat.com>
Signed-off-by: Itamar Holder <iholder@redhat.com>
Signed-off-by: Itamar Holder <iholder@redhat.com>
Signed-off-by: Itamar Holder <iholder@redhat.com>
@iholder101
Copy link
Contributor Author

Thanks a lot @haircommander and @kannon92 for your reviews! Much appreciated!
I believe all comments are now addressed 🙏 PTAL


<!-- overview -->

This page provides an example of how to provision and configure swap memory on a Kubernetes node using kubeadm.
Copy link
Contributor

Choose a reason for hiding this comment

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

should there be something that makes it clear this is linux only early on?

Copy link
Contributor

Choose a reason for hiding this comment

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

ah you mention it below that's prbaobly fine

@haircommander
Copy link
Contributor

this is an excellent improvement
/lgtm

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

LGTM label has been added.

Git tree hash: 6242b4d55807a1ca14edc11f1bf45f7b54d699c6

@iholder101
Copy link
Contributor Author

@natalisucks can you please take another look?

@lmktfy
Copy link
Contributor

lmktfy commented Jul 14, 2025

/approve

Thanks, @iholder101.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lmktfy

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 Jul 14, 2025
@k8s-ci-robot k8s-ci-robot merged commit b646a98 into kubernetes:main Jul 14, 2025
6 checks passed
@natalisucks
Copy link
Contributor

thanks everyone for your reviews and work! nice addition, @iholder101 🎉

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/node Categorizes an issue or PR as relevant to SIG Node. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Development

Successfully merging this pull request may close these issues.

Documentation updates for k8s Node swap monitoring and troubleshooting. Target: 1.34
7 participants