Change vm.max_map_count default to 1048576 in All ES docs for version 8.16+ #4295
Conversation
kunisen
added
documentation
✅ Vale Linting ResultsNo issues found on modified lines! |
🔍 Preview links for changed docs |
Co-authored-by: Vlada Chirmicci <[email protected]>
Co-authored-by: Vlada Chirmicci <[email protected]>
|
Thank you @yetanothertw for the review and valuable advice as always! 🙏 By the way, may I have one question about format please? I see the admonition directive doesn't seem to show markdown format but shows "`" as is. 
My question is, should I use ` to quote, or should I avoid using the it? To be more specific, should I do A) or B) please?
|
|
|
||
| # Increase virtual memory [vm-max-map-count] | ||
|
|
||
| {{es}} uses a [`mmapfs`](elasticsearch://reference/elasticsearch/index-settings/store.md#mmapfs) directory by default to store its indices. The default operating system limits on mmap counts is likely to be too low, which may result in out of memory exceptions. |
There was a problem hiding this comment.
We say here "The default operating system limits on mmap counts is likely to be too low" but that is no longer true. I think your addition below supersedes this statement and we can remove it.
lkts
left a comment
lkts
left a comment
There was a problem hiding this comment.
Thank you for driving this change. I have one suggestion, otherwise LGTM.
|
|
||
| {{es}} uses a [`mmapfs`](elasticsearch://reference/elasticsearch/index-settings/store.md#mmapfs) directory by default to store its indices. The default operating system limits on mmap counts is likely to be too low, which may result in out of memory exceptions. | ||
|
|
||
| :::{admonition} Verify `vm.max_map_count` configuration |
There was a problem hiding this comment.
| :::{admonition} Verify `vm.max_map_count` configuration | |
| :::{admonition} Verify vm.max_map_count configuration |
Thanks for spotting this @kunisen -- I missed it!
I think we should go with option B (as described in your comment).
|
is this something that should be checked on upgrade, too? that's what I gathered from a couple of the slack conversations |
Summary
This is to address https://github.com/elastic/docs-content-internal/issues/592.
I am raising this as the first PR to decide the wording with docs, and ES dev / PM team. Thanks!
Generative AI disclosure
Preview / View
Before PR merge
deploy-manage/deploy/self-managed/vm-max-map-count.md
After PR merge
https://www.elastic.co/docs/deploy-manage/deploy/self-managed/vm-max-map-count