Add docs on transparent huge pages (THP) setting #19343
Open
+6
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Files changed: |
|
@RaduBerinde i added this to v25.1 docs so we can verify language what previous versions should also have this guidance? |
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify site configuration. |
RaduBerinde
requested changes
Feb 4, 2025
| @@ -22,6 +22,15 @@ 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). | |||
|
|
|||
| New deployments should configure [transparent huge pages (THP)](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html) with the `madvise` option: | |||
There was a problem hiding this comment.
Maybe give a bit of the reasoning: "We have observed (in rare cases) increased memory usage due to transparent huge pages (THP) being enabled (set to always). New deployments should ..."
|
@RaduBerinde this may go without saying but I guess since this docs change is about the OS config it can be backported to v23.1+ docs? (once we're happy with it) or are there CRDB-version-related considerations? please advise, thanks! |
RaduBerinde
approved these changes
Feb 6, 2025
|
Looks great! Yes, we should backport. |
taroface
approved these changes
Feb 12, 2025
|
|
||
| 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. |
There was a problem hiding this comment.
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). |
| @@ -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. | |||
There was a problem hiding this comment.
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. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes DOC-12097