Skip to content

Commit f207490

Browse files
author
Christopher Frost
committed
Document the minimum Xss requirement
As described in the GitHub issue, this commit adds documentation about the minimum stack value that may prevent JRE startup. This will only occur should the use edit the default configuration. Close cloudfoundry#228 [#103782484]
1 parent 8ab211a commit f207490

2 files changed

Lines changed: 6 additions & 2 deletions

File tree

docs/jre-open_jdk_jre.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,9 @@ To add custom SSL certificates, add your `cacerts` file to `resources/open_jdk_j
3838
### Memory
3939
The total available memory is specified when an application is pushed as part of it's configuration. The Java buildpack uses this value to control the JRE's use of various regions of memory. The JRE memory settings can be influenced by configuring the `memory_sizes`, `memory_heuristics`, `memory_initials` and/or `stack_threads` mappings.
4040

41-
Note: if the total available memory is scaled up or down, the Java buildpack will re-calculate the JRE memory settings the next time the application is started.
41+
Note: If the total available memory is scaled up or down, the Java buildpack will re-calculate the JRE memory settings the next time the application is started.
42+
43+
Note: If setting an initial Stack size, depending on the version of Java and the operating system used by Cloud Foundry the JRE will require a minimum `-Xss` value. This tends to be between `100k` and `250k`.
4244

4345
#### Memory Sizes
4446
The following optional properties may be specified in the `memory_sizes` mapping.

docs/jre-oracle_jre.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,9 @@ To add custom SSL certificates, add your `cacerts` file to `resources/oracle_jre
4646
### Memory
4747
The total available memory is specified when an application is pushed as part of it's configuration. The Java buildpack uses this value to control the JRE's use of various regions of memory. The JRE memory settings can be influenced by configuring the `memory_sizes`, `memory_heuristics`, `memory_initials` and/or `stack_threads` mappings.
4848

49-
Note: if the total available memory is scaled up or down, the Java buildpack will re-calculate the JRE memory settings the next time the application is started.
49+
Note: If the total available memory is scaled up or down, the Java buildpack will re-calculate the JRE memory settings the next time the application is started.
50+
51+
Note: If setting an initial Stack size, depending on the version of Java and the operating system used by Cloud Foundry the JRE will require a minimum `-Xss` value. This tends to be between `100k` and `250k`.
5052

5153
#### Memory Sizes
5254
The following optional properties may be specified in the `memory_sizes` mapping.

0 commit comments

Comments
 (0)