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.

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 section about virtual memory to Elasticsearch doc #1214

Merged
merged 9 commits into from
Jul 15, 2019
27 changes: 27 additions & 0 deletions docs/elasticsearch-spec.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -100,3 +100,30 @@ Example to create a Kubernetes TLS secret with a self-signed certificate:
$ openssl req -x509 -newkey rsa:4096 -keyout tls.key -out tls.crt -days 365 -nodes
$ kubectl create secret tls my-cert --cert tls.crt --key tls.key
----

[id="{p}-virtual-memory"]
=== Virtual memory
artemnikitin marked this conversation as resolved.
Show resolved Hide resolved

By default, Elasticsearch is using memory mapping (mmap) to efficiently access indexes. Usually, default values for virtual address space on Linux distributions is too low for Elasticsearch to work properly, which may result in out of memory exceptions. To increase virtual memory ECK will set recommended value by default. This is requires the kubelet to allow running privileged containers.
artemnikitin marked this conversation as resolved.
Show resolved Hide resolved
You may disable it by explicitly setting value to `false`
artemnikitin marked this conversation as resolved.
Show resolved Hide resolved
[source,yaml]
----
spec:
setVmMaxMapCount: false
----


To get more info about this setting you cah check Elasticsearch documentation:
artemnikitin marked this conversation as resolved.
Show resolved Hide resolved
https://www.elastic.co/guide/en/elasticsearch/reference/current/vm-max-map-count.html

Optionally, you can select a different type of storage for your Elasticsearch cluster. Here you can find information about possible options:
artemnikitin marked this conversation as resolved.
Show resolved Hide resolved
https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-store.html

[source,yaml]
----
spec:
nodes:
- nodeCount: 3
config:
index.store.type: niofs
----