Remove setVmMaxMapCount from Elasticsearch CRD #1839
Conversation
docs/elasticsearch-spec.asciidoc
Outdated
| @@ -171,16 +171,37 @@ spec: | |||
| === Virtual memory | |||
|
|
|||
| By default, Elasticsearch uses memory mapping (`mmap`) to efficiently access indices. | |||
| Usually, default values for virtual address space on Linux distributions are too low for Elasticsearch to work properly, which may result in out-of-memory exceptions. | |||
| To increase virtual memory, ECK sets the recommended value by default. | |||
| Usually, default values for virtual address space on Linux distributions are too low for Elasticsearch to work properly, which may result in out-of-memory exceptions. This is why the quickstart example disables `mmap` via the `node.store.allow_mmap: false` setting. For production workloads, it is strongly recommended to increase the kernel setting `vm.max_map_count` to `2621441` and leave `node.store.allow_mmap` unset. | |||
There was a problem hiding this comment.
Do you want to link back to the 'quickstart' here, while it is abundantly clear for people working on ECK what is meant, it might not be clear for other readers.
Do you mean this part: https://github.com/elastic/cloud-on-k8s/pull/1839/files#diff-a131bd60e1a908bde08e6409a55c9415R195 or something else? |
Yeah I mean this yaml snippet (the init container) to include in https://github.com/elastic/cloud-on-k8s/blob/master/config/samples/elasticsearch/elasticsearch.yaml, as an example. |
| EOF | ||
| ---- | ||
|
|
||
| The operator automatically manages Pods and resources corresponding to the desired cluster. It may take up to a few minutes until the cluster is ready. | ||
|
|
||
| Note that `node.store.allow_mmap: false` has performance implications and should be tuned for production workloads as described link:k8s-elasticsearch-spec.html#virtual-memory[here]. |
There was a problem hiding this comment.
Link is broken. I believe this has to be k8s-virtual-memory.html
There was a problem hiding this comment.
That part I wasn't sure about, so was trying to get a doc build locally and failing. Will add some notes in a readme about how to build docs locally once I get it figured out
pebrc
changed the title
Resolves #1712
The doc build is failing locally and I'm not sure what I'm missing, will need to troubleshoot in the future