Browse Source

Clarify heap setting in Docker docs (#42754)

Add note in the Docker docs that even when container memory is limited,
we still require specifying -Xms/-Xmx using one of the supported
methods.
Dimitrios Liappis 6 years ago
parent
commit
481b359da3
1 changed files with 6 additions and 0 deletions
  1. 6 0
      docs/reference/setup/install/docker.asciidoc

+ 6 - 0
docs/reference/setup/install/docker.asciidoc

@@ -372,6 +372,12 @@ published ports with `--publish-all`, unless you are pinning one container per h
 
 . Use the `ES_JAVA_OPTS` environment variable to set heap size. For example, to
 use 16GB, use `-e ES_JAVA_OPTS="-Xms16g -Xmx16g"` with `docker run`.
++
+--
+NOTE: You still need to <<heap-size,configure the heap size>> even if you are
+https://docs.docker.com/config/containers/resource_constraints/#limit-a-containers-access-to-memory[limiting
+memory access] to the container.
+--
 
 . Pin your deployments to a specific version of the {es} Docker image, for
 example +docker.elastic.co/elasticsearch/elasticsearch:{version}+.