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.

Sign up for GitHub

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

Jump to bottom

Update instructions in relation to the recent addition of support for Oracle GraalVM #747

Merged
merged 3 commits into from
Dec 19, 2023
Merged

Update instructions in relation to the recent addition of support for Oracle GraalVM #747

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2683370
Update instructions in relation to the recent addition of support for…
dmikusa Dec 7, 2023
ee8b514
Update content/docs/howto/java.md
anthonydahanne Dec 19, 2023
d06aefa
Merge branch 'main' into java-graalvm-update
anthonydahanne Dec 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 8 additions & 30 deletions content/docs/howto/java.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -469,47 +469,25 @@ The resulting application image will be identical to that built in the "Building

### Inspect the Native Image Tools Version

The exact substrate VM version that was contributed to a given image can be read from the Bill-of-Materials.
The exact Native Image version that was contributed to a given image can be read from the Bill-of-Materials.

**Example** Inspecting the JRE Version

Please refer to the [Access the SBOM article][howto/sbom] to find out how you can inspect the JRE using SBOM information.

### Configure the GraalVM Version

Because GraalVM is evolving rapidly you may on occasion need to, for compatibility reasons, select a specific version of the GraalVM and associated tools to use when building an image. This is not a directly configurable option like the JVM version, however, you can pick a specific version by changing the version of the Java Native Image Buildpack you use.

The following table documents the versions available.

| GraalVM Version | Java Native Image Buildpack Version |
| --------------- | ----------------------------------- |
| 22.3 | 7.44.3 |
| 22.2 | 7.26.1 |
| 22.1 | 7.16.2 |
| 22.0 | 7.8.1 |
| 21.3 | 5.12.0 |
| 21.2 | 5.5.0 |
| 21.1 | 5.4.0 |
| 21.0 | 5.3.0 |

For example, to select GraalVM 22.1:

{{< code/copyable >}}
pack build samples/native -e BP_NATIVE_IMAGE=true --buildpack paketo-buildpacks/ca-certificates --buildpack paketo-buildpacks/java-native-image@7.16.2
{{< /code/copyable >}}

### Use an Alternative Java Native Image Toolkit

By default, the [Paketo Java Native Image buildpack][bp/java-native-image] will use BellSoft's Native Image Toolkit. The following Paketo JVM buildpacks may be used to substitute alternate Native Image Toolkit implementations in place of the default.

| JVM | Buildpack |
| ------------------------------------------------------------------------- | ---------------------------------------------------------- |
| [BellSoft Liberica](https://bell-sw.com/pages/liberica-native-image-kit/) | [Paketo BellSoft Liberica Buildpack][bp/bellsoft-liberica] |
| [GraalVM][graalvm] | [Paketo GraalVM Buildpack][bp/graalvm] |
| JVM | Buildpack |
| ------------------------------------------------------------------------- | -------------------------------------------------------------- |
| [BellSoft Liberica](https://bell-sw.com/pages/liberica-native-image-kit/) | [Paketo Buildpack for BellSoft Liberica][bp/bellsoft-liberica] |
| [GraalVM Community Edition][graalvm] | [Paketo Buildpack for GraalVM Community Edition][bp/graalvm] |
| [Oracle GraalVM][oracle-graalvm] | [Paketo Buildpack for Oracle][bp/oracle] |

To use an alternative Java Native Image Toolkit, you will need to set two `--buildpack` arguments to `pack build`, one for the alternative Java Native Image Toolkit buildpack you'd like to use and one for the Paketo Java Native Image buildpack (in that order). This works because while you end up with two Java Native Image Toolkit buildpacks, the first one, the one you're specifying will claim the build plan entries so the second one will end up being a no-op and doing nothing.

This example will switch in the GraalVM buildpack:
This example will switch in the GraalVM Community Edition buildpack:

<!-- spellchecker-disable -->
{{< code/copyable >}}
Expand Down Expand Up @@ -839,8 +817,8 @@ Each argument provided to the launcher will be evaluated by the shell prior to e
[executable jar]:https://en.wikipedia.org/wiki/JAR_(file_format)#Executable_JAR_files
[graalvm feature]:https://www.graalvm.org/sdk/javadoc/org/graalvm/nativeimage/hosted/Feature.html
[graalvm native image]:https://www.graalvm.org/reference-manual/native-image/
[graalvm substrate vm]:https://www.graalvm.org/reference-manual/native-image/SubstrateVM/
[graalvm]:https://www.graalvm.org/docs/introduction/
[oracle-graalvm]:https://www.oracle.com/java/graalvm/
[gradle]:https://gradle.org/
[java]:https://github.com/paketo-buildpacks/java
[jconsole]:https://openjdk.java.net/tools/svc/jconsole/
Expand Down
Loading