Change vm.max_map_count default to 1048576 in All ES docs for version 8.16+

[kunisen]

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

1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?

• Yes
• No

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

[github-actions]

Vale Linting Results

Summary: 1 suggestion found

💡 Suggestions (1)

File	Line	Rule	Message
deploy-manage/deploy/self-managed/vm-max-map-count.md	13	Elastic.WordChoice	Consider using 'can, might' instead of 'may', unless the term is in the UI.

[github-actions]

🔍 Preview links for changed docs

• deploy-manage/deploy/self-managed/vm-max-map-count.md

[yetanothertw]

LGTM, thank you!

[kunisen]

Thank you @yetanothertw for the review and valuable advice as always! 🙏
I will wait for engineering / PM's input & review before I go merge. Thanks for your patience.

---

By the way, may I have one question about format please?
https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/4295/deploy-manage/deploy/self-managed/vm-max-map-count

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?

• A)

Verify `vm.max_map_count` configuration

• B)

Verify vm.max_map_count configuration

[lkts]

Thank you for driving this change. I have one suggestion, otherwise LGTM.

[shainaraskas]

is this something that should be checked on upgrade, too? that's what I gathered from a couple of the slack conversations

[kunisen]

Thanks @shainaraskas

is this something that should be checked on upgrade, too? that's what I gathered from a couple of the slack conversations

Yes. We should check this value when ES upgrade to 8.16+.

However, it's OS setting so I am unsure if we can let ES API (migration APIs) or Kibana upgrade assistant detect it and do the suggestion.

I think from docs perspective, we can add one section like "review your prerequisite settings", and this vm.max_map_count belongs to Increase virtual memory which is also part of the Important system configuration, which can be considered as "prerequisites".

From support and doc perspective, I think we may want to have this as an essential section, to make sure we can cover the things we need. (Another essential section we'd think could be important, is a reference to known issue. We may want to add that to help customer skip some version or take some prevention steps before things become too late after they upgrade)

---

But it's not my area (cloud) so I'd like to defer to ES friends (@bytebilly @lkts) for insights on this.

[kunisen]

I will do merge given we got approval from both ES and doc teams. Thank you all for the great help!