gcr.io/paketo-buildpacks/graalvm
The Paketo GraalVM Buildpack is a Cloud Native Buildpack that provides the GraalVM implementations of the JDK and GraalVM Native Image builder.
This buildpack is designed to work in collaboration with other buildpacks which request contributions of JREs, JDKs, or Native Image builder.
Behavior
This buildpack will participate if any of the following conditions are met
- Another buildpack requires
jdk - Another buildpack requires
jre - Another buildpack requires
native-image-builder
The buildpack will do the following if a JDK is requested:
- Contributes a JDK to a layer marked
buildandcachewith all commands on$PATH - Contributes
$JAVA_HOMEconfigured to the build layer - Contributes
$JDK_HOMEconfigure to the build layer
The buildpack will do the following if native-image-builder is requested:
- Contribute a JDK (see above)
- Installs the Native Image Substrate VM into the JDK
- Prevents the JRE from being installed, even if requested
The buildpack will do the following if a JRE is requested:
- Contributes a JDK to a layer with all commands on
$PATH(GraalVM does not distribute a standalone JRE) - Contributes
$JAVA_HOMEconfigured to the layer - Contributes
-XX:ActiveProcessorCountto the layer - Contributes
-XX:+ExitOnOutOfMemoryErrorto the layer - Contributes
-XX:+UnlockDiagnosticVMOptions,-XX:NativeMemoryTracking=summary&-XX:+PrintNMTStatisticsto the layer (Java NMT) - If
BPL_JMX_ENABLED = true- Contributes
-Djava.rmi.server.hostname=127.0.0.1,-Dcom.sun.management.jmxremote.authenticate=false,-Dcom.sun.management.jmxremote.ssl=false&-Dcom.sun.management.jmxremote.rmi.port=5000
- Contributes
- If
BPL_DEBUG_ENABLED = true- Contributes
-agentlib:jdwp=transport=dt_socket,server=y,address=*:8000,suspend=n.
- Contributes
- If
BPL_JFR_ENABLED = true- Contributes
-XX:StartFlightRecording=dumponexit=true,filename=/tmp/recording.jfr
- Contributes
- Contributes
$MALLOC_ARENA_MAXto the layer - Disables JVM DNS caching if link-local DNS is available
- If
metadata.build = true- Marks layer as
buildandcache
- Marks layer as
- If
metadata.launch = true- Marks layer as
launch
- Marks layer as
- Contributes Memory Calculator to a layer marked
launch - Contributes Heap Dump helper to a layer marked
launch
Configuration
| Environment Variable | Description |
|---|---|
$BP_JVM_VERSION |
Configure a specific JVM version (e.g. 11, 17). The buildpack will download JDK and Native Image Substrate VM assets that are compatible with this version of the JVM specification. Since the buildpack only ships a single version of each supported line, updates to the buildpack can change the exact version of the JDK or JRE. In order to hold the JDK and JRE versions stable, the buildpack version itself must be stable.Buildpack releases (and the dependency versions for each release) can be found here. Few users will use this buildpack directly, instead consuming a language buildpack like |
$BPL_JVM_HEAD_ROOM |
Configure the percentage of headroom the memory calculator will allocated. Defaults to 0. |
$BPL_JVM_LOADED_CLASS_COUNT |
Configure the number of classes that will be loaded at runtime. Defaults to 35% of the number of classes. |
$BPL_JVM_THREAD_COUNT |
Configure the number of user threads at runtime. Defaults to 250. |
$BPL_JAVA_NMT_ENABLED |
Configure whether Java Native Memory Tracking (NMT) is enabled. Defaults to true. Set this to false to disable NMT functionality. |
$BPL_JAVA_NMT_LEVEL |
Configure the level of detail for Java Native Memory Tracking (NMT) output. Defaults to summary. Set this to detail for detailed NMT output. |
$BPL_JMX_ENABLED |
Configure whether Java Management Extensions (JMX) is enabled. Defaults to false. Set this to true to enable JMX functionality. |
$BPL_JMX_PORT |
Configure the port number for JMX. Defaults to 5000. When running the container, this value should match the port published locally, i.e. for Docker: --publish 5000:5000 |
$BPL_DEBUG_ENABLED |
Configure whether remote debugging features are enabled. Defaults to false. Set this to true to enable remote debugging. |
$BPL_DEBUG_PORT |
Configure the port number for remote debugging. Defaults to 8000. |
$BPL_DEBUG_SUSPEND |
Configure whether to suspend execution until a debugger has attached. Defaults to false. |
$BPL_JFR_ENABLED |
Configure whether Java Flight Recording (JFR) is enabled. If no arguments are specified via BPL_JFR_ARGS, the default config args dumponexit=true,filename=/tmp/recording.jfr are added. |
$BPL_JFR_ARGS |
Configure custom arguments to Java Flight Recording, via a comma-separated list, e.g. duration=10s,maxage=1m. If any values are specified, no default args are supplied. |
$BPL_HEAP_DUMP_PATH |
Configure the location for writing heap dumps in the event of an OutOfMemoryError exception. Defaults to ``, which disables writing heap dumps. The path set must be writable by the JVM process. |
$JAVA_TOOL_OPTIONS |
Configure the JVM launch flags |
Bindings
The buildpack optionally accepts the following bindings:
Type: dependency-mapping
| Key | Value | Description |
|---|---|---|
<dependency-digest> |
<uri> |
If needed, the buildpack will fetch the dependency with digest <dependency-digest> from <uri> |
License
This buildpack is released under version 2.0 of the Apache License.