Merge pull request #11697 from cescoffier/features/indicate-java11-fo…

…r-graalvm Indicate that Quarkus only works with the Java 11 version of GraalVM (in native mode).
quarkusio · Aug 28, 2020 · c5da033 · c5da033
2 parents d410dd6 + b417b97
commit c5da033
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 12 deletions.
diff --git a/docs/src/main/asciidoc/README.adoc b/docs/src/main/asciidoc/README.adoc
@@ -45,5 +45,5 @@ complete list of externalized variables for use is given in the following table:
 |\{quickstarts-tree-url}|{quickstarts-tree-url}| Quickstarts URL to master source tree root; used for referencing directories.
 
 |\{graalvm-version}|{graalvm-version}| Recommended GraalVM version to use.
-|\{graalvm-flavor}|{graalvm-flavor}| The full flavor of GraaVM to use e.g. `19.3.1-java11`.
+|\{graalvm-flavor}|{graalvm-flavor}| The full flavor of GraaVM to use e.g. `19.3.1-java11`. Make sure to use a `java11` version.
 |===
diff --git a/docs/src/main/asciidoc/building-native-image.adoc b/docs/src/main/asciidoc/building-native-image.adoc
@@ -39,12 +39,6 @@ This means that it does not profit from a few small enhancements that Oracle hav
 This enhancements are omitted because upstream OpenJDK does not manage them, and cannot vouch for.
 This is particularly important when it comes to conformance and security.
 
-* Mandrel is only available for projects that can be compiled with Java 11.
-If you are using Java 8,
-you should consider using Oracle GraalVM instead.
-The reason for not using Java 8 is because it's a legacy release,
-which most Quarkus users are unlikely to need.
-
 * Mandrel is currently only recommended for building native executables that target Linux containerized environments.
 This means that Mandrel users should use containers to build their native executables.
 If you are building native executables for macOS or Windows target platforms,
@@ -56,6 +50,13 @@ and https://github.com/graalvm/mandrel/releases[Mandrel releases].
 
 The prerequisites vary slightly depending on whether you are using Oracle GraalVM CE/EE or Mandrel.
 
+[IMPORTANT]
+.Install the Java 11 version of GraalVM
+====
+While Oracle GraalVM is available for both Java 8 and Java 11 (Mandrel only supports Java 11), Quarkus only works with the Java 11 version.
+If you use the Oracle distribution, make sure to install the Java 11 version.
+====
+
 == Prerequisites for Mandrel
 
 To complete this guide using Mandrel, you need:
@@ -77,7 +78,7 @@ To complete this guide, you need:
 * an IDE
 * JDK 11 installed with `JAVA_HOME` configured appropriately
 * A xref:configuring-c-development[working C development environment]
-* GraalVM version {graalvm-version} installed and xref:configuring-graalvm[configured appropriately]
+* GraalVM version {graalvm-version} (be sure to install the Java 11 support) installed and xref:configuring-graalvm[configured appropriately]
 * A working container runtime (Docker, podman)
 * The code of the application developed in the link:getting-started[Getting Started Guide].
 
@@ -115,9 +116,10 @@ If you cannot install GraalVM, you can use a multi-stage Docker build to run Mav
 
 Version {graalvm-version} is required. Using the community edition is enough.
 
-1. Install GraalVM if you haven't already. You have a few options for this:
+1. Install GraalVM (pick the java 11 version) if you haven't already. You have a few options for this:
 ** Use platform-specific install tools like https://github.com/graalvm/homebrew-tap[homebrew], https://sdkman.io/jdks#Oracle[sdkman], or https://github.com/ScoopInstaller/Java[scoop].
 ** Download the appropriate Community Edition archive from <https://github.com/graalvm/graalvm-ce-builds/releases>, and unpack it like you would any other JDK.
+Make sure to download and install at Java 11 version.
 2. Configure the runtime environment. Set `GRAALVM_HOME` environment variable to the GraalVM installation directory, for example:
 +
 [source,shell]

diff --git a/docs/src/main/asciidoc/gradle-tooling.adoc b/docs/src/main/asciidoc/gradle-tooling.adoc
@@ -298,7 +298,7 @@ Open the project directory in VS Code. If you have installed the Java Extension
 
 Native executables make Quarkus applications ideal for containers and serverless workloads.
 
-Make sure to have `GRAALVM_HOME` configured and pointing to GraalVM version {graalvm-version}.
+Make sure to have `GRAALVM_HOME` configured and pointing to GraalVM version {graalvm-version} (Make sure to use a Java 11 version of GraalVM).
 
 Create a native executable using: `./gradlew build -Dquarkus.package.type=native`.
 A native executable will be present in `build/`.

diff --git a/docs/src/main/asciidoc/maven-tooling.adoc b/docs/src/main/asciidoc/maven-tooling.adoc
@@ -335,7 +335,7 @@ Now you should be able to execute `./mvnw quarkus-bootstrap:build-tree` on your
 
 Native executables make Quarkus applications ideal for containers and serverless workloads.
 
-Make sure to have `GRAALVM_HOME` configured and pointing to GraalVM version {graalvm-version}.
+Make sure to have `GRAALVM_HOME` configured and pointing to GraalVM version {graalvm-version} (Make sure to use a Java 11 version of GraalVM).
 Verify that your `pom.xml` has the proper `native` profile (see <<build-tool-maven>>).
 
 Create a native executable using: `./mvnw package -Pnative`.

diff --git a/docs/src/main/asciidoc/native-and-ssl.adoc b/docs/src/main/asciidoc/native-and-ssl.adoc
@@ -20,7 +20,7 @@ To complete this guide, you need:
 
 * less than 20 minutes
 * an IDE
-* GraalVM installed with `JAVA_HOME` and `GRAALVM_HOME` configured appropriately
+* GraalVM (Java 11) installed with `JAVA_HOME` and `GRAALVM_HOME` configured appropriately
 * Apache Maven {maven-version}
 
 This guide is based on the REST client guide so you should get this Maven project first.