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

Gently deprecate the MEMORY variable #742

Closed
itzg opened this issue Feb 1, 2021 · 0 comments
Closed

Gently deprecate the MEMORY variable #742

itzg opened this issue Feb 1, 2021 · 0 comments
Labels
priority/high status/ready to test An image or docs update is ready to be tested by the reporter

Comments

@itzg
Copy link
Owner

itzg commented Feb 1, 2021

The variable name MEMORY is misleading since it really refers to the JVM heap allocation. While that amount of memory usage is the majority of the overall Java process memory usage it is not 100% of it. As such, it is too easy to interpret that the container memory resource limit should be set to the same value.

A new variable naming should be introduced such as JAVA_HEAP which will be the shortcut setting for MAX_JAVA_HEAP and INITIAL_JAVA_HEAP. All of the above should use the MEMORY equivalent when set.

When the MEMORY variables are explicitly set the startup scripts should output a deprecation warning and clarify that resource limit should be set higher.

The documentation should point out some recommendations or strategies for determining the additional non-heap amount to allow.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority/high status/ready to test An image or docs update is ready to be tested by the reporter
Projects
None yet
Development

No branches or pull requests

1 participant