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.

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

Add docs on transparent huge pages (THP) setting #19343

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+6 −0
Open

Add docs on transparent huge pages (THP) setting #19343

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f1df358
Add docs on transparent huge pages (THP) setting
rmloveland Feb 4, 2025
e1d7693
Update with RaduBerinde feedback (1)
rmloveland Feb 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/current/v25.1/recommended-production-settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,12 @@ For optimal cluster performance, Cockroach Labs recommends that all nodes use th

We recommend running a [glibc](https://www.gnu.org/software/libc/)-based Linux distribution and Linux kernel version from the last 5 years, such as [Ubuntu](https://ubuntu.com/), [Red Hat Enterprise Linux (RHEL)](https://www.redhat.com/technologies/linux-platforms/enterprise-linux), [CentOS](https://www.centos.org/), or [Container-Optimized OS](https://cloud.google.com/container-optimized-os/docs).

We have observed increased memory usage in rare cases due to transparent huge pages (THP) being enabled (i.e., set to `always`). New deployments should configure [transparent huge pages (THP)](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html) with the `madvise` option.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
We have observed increased memory usage in rare cases due to transparent huge pages (THP) being enabled (i.e., set to `always`). New deployments should configure [transparent huge pages (THP)](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html) with the `madvise` option.
We have observed increased memory usage in rare cases due to [transparent huge pages (THP)](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html) being enabled (i.e., set to `always`). New deployments should configure THP with the `madvise` option.


Existing deployments that have THP enabled using the `always` option should change it to `madvise` unless they are currently running with a comfortable memory usage margin.

The method for permanently changing the THP setting across reboots depends on the operating system. For Red Hat Enterprise Linux, see https://access.redhat.com/solutions/46111.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The method for permanently changing the THP setting across reboots depends on the operating system. For Red Hat Enterprise Linux, see https://access.redhat.com/solutions/46111.
The method for permanently changing the THP setting across reboots depends on the operating system. For Red Hat Enterprise Linux, refer to the [Red Hat documentation](https://access.redhat.com/solutions/46111).


## Hardware

{% include {{ page.version.version }}/prod-deployment/terminology-vcpu.md %}
Expand Down
Loading