crate / docker-crate

Source repository for the official CrateDB Docker image
https://registry.hub.docker.com/_/crate/
Apache License 2.0
49 stars 22 forks source link

Raise default heap size? #208

Closed robd003 closed 10 months ago

robd003 commented 2 years ago

I noticed in the Memory configuration section it says the heap should be set to 1GB minimum.

Should the 512mb limit be updated in the Docker files to reflect this?

amotl commented 10 months ago

@AishwaryaNaikare also reported about eventual issues with too less memory.

I tried to solve it by the open source version, but I kept getting parsing and heap-related issues.

-- https://community.cratedb.com/chat/c/-/4/67

seut commented 10 months ago

@robd003 Thanks for this suggestion and sorry for our very delayed answer.

We discussed this internally and disagreed to increase the docker default as the docker image is used in development setups with sometimes limited resources. E.g.:

Most of these scenarios are working fine with the existing default of 512MB. Instead of requiring more memory by default, we plan to adjust our documentation to highlight this fact and also encourage users to adjust it (e.g. by adding the --env CRATE_HEAP_SIZE=1g argument to existing examples).

Our tarball sets the minimum HEAP (-Xms) while leaving the maximum HEAP configuration (-Xmx) unset which results in using the maximum available memory if needed, to simplify development setups. Additionally, CrateDB treats a loopback interface only binding as a development-only setup, and will not run any bootstrap checks to allow such an non-optimized configuration which should be avoided in production. In a docker container, the node will, by default, bind to the docker network interface in addition to the loopback interface in order to be accessible outside of the container. This enables the bootstrap checks, so a sane max HEAP must be defined to bootstrap CrateDB in a docker setup.

seut commented 10 months ago

The documentation task is tracked by another issue, so I'm closing this.