Skip to content

Commit

Permalink
Merge pull request #37697 from michalvavrik/docs/prerequisities-jdk-17
Browse files Browse the repository at this point in the history
Document that JDK 17+ is Quarkus prerequisity
  • Loading branch information
gsmet committed Dec 12, 2023
2 parents c757c4a + bd53f84 commit 6f2d773
Show file tree
Hide file tree
Showing 8 changed files with 11 additions and 18 deletions.
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/_includes/prerequisites.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ ifndef::prerequisites-time[]
endif::[]
* An IDE
ifdef::prerequisites-ide[{prerequisites-ide}]
* JDK 11+ installed with `JAVA_HOME` configured appropriately
* JDK 17+ installed with `JAVA_HOME` configured appropriately
ifndef::prerequisites-no-maven[]
* Apache Maven {maven-version}
endif::[]
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/ansible.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ By default, the Ansible collection for Quarkus will install and use the OpenJDK
[source,bash]
----
$ ansible-playbook -i inventory ...
-e quarkus_java_package_version: java-11-openjdk
-e quarkus_java_package_version: java-17-openjdk
----
====

Expand Down
6 changes: 3 additions & 3 deletions docs/src/main/asciidoc/cli-tooling.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ You can use Homebrew to install (and update) the Quarkus CLI.
Make sure you have a JDK installed before installing the Quarkus CLI.
We haven't added an explicit dependency as we wanted to make sure you could use your preferred JDK version.
You can install a JDK with `brew install openjdk` for the latest Java version, `brew install openjdk@17` for Java 17, or `brew install openjdk@11` for Java 11.
You can install a JDK with `brew install openjdk` for the latest Java version, `brew install openjdk@17` for Java 17, or `brew install openjdk@21` for Java 21.
====
To install the Quarkus CLI using Homebrew, run the following command:
Expand Down Expand Up @@ -190,7 +190,7 @@ You can use Chocolatey to install (and update) the Quarkus CLI.
====
Make sure you have a JDK installed before installing the Quarkus CLI.
You can install a JDK with `choco install ojdkbuild17` for Java 17 or `choco install ojdkbuild11` for Java 11.
You can install a JDK with `choco install temurin17` for Java 17 or `choco install temurin21` for Java 21.
====
To install the Quarkus CLI using Chocolatey, run the following command:
Expand Down Expand Up @@ -226,7 +226,7 @@ You can use Scoop to install (and update) the Quarkus CLI.
[NOTE]
====
Make sure you have a JDK installed before installing the Quarkus CLI.
You can install a JDK with `scoop install openjdk17` for Java 17 or `scoop install openjdk11` for Java 11.
You can install a JDK with `scoop install openjdk17` for Java 17 or `scoop install openjdk21` for Java 21.
====
To install the Quarkus CLI using Scoop, run the following command:
[source,shell]
Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/asciidoc/deploying-to-heroku.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -92,11 +92,11 @@ Two additional files are needed in your application's root directory:
* `system.properties` to configure the Java version
* `Procfile` to configure how Heroku starts your application

Quarkus needs JDK 11, so we specify that first:
Quarkus needs JDK 17, so we specify that first:

[source,bash]
----
echo "java.runtime.version=11" >> system.properties
echo "java.runtime.version=17" >> system.properties
git add system.properties
git commit -am "Configure the Java version for Heroku."
----
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/funqy-gcp-functions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ You will have a single JAR inside the `target/deployment` repository that contai
Then you will be able to use `gcloud` to deploy your function to Google Cloud.
The `gcloud` command will be different depending on which event triggers your function.

NOTE: We will use the Java 17 runtime but you can switch to the Java 11 runtime by using `--runtime=java11` instead of `--runtime=java17` on the deploy commands.
NOTE: We will use the Java 17 runtime but you can switch to the Java 21 runtime by using `--runtime=java21` instead of `--runtime=java17` on the deploy commands.

[WARNING]
====
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/gcp-functions-http.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ The result of the previous command is a single JAR file inside the `target/deplo

Then you will be able to use `gcloud` to deploy your function to Google Cloud.

NOTE: We will use the Java 17 runtime but you can switch to the Java 11 runtime by using `--runtime=java11` instead of `--runtime=java17` on the deploy commands.
NOTE: We will use the Java 17 runtime but you can switch to the Java 21 runtime by using `--runtime=java21` instead of `--runtime=java17` on the deploy commands.

[source,bash]
----
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/gcp-functions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ The result of the previous command is a single JAR file inside the `target/deplo
Then you will be able to use `gcloud` to deploy your function to Google Cloud.
The `gcloud` command will be different depending on which event triggers your function.

NOTE: We will use the Java 17 runtime but you can switch to the Java 11 runtime by using `--runtime=java11` instead of `--runtime=java17` on the deploy commands.
NOTE: We will use the Java 17 runtime but you can switch to the Java 21 runtime by using `--runtime=java21` instead of `--runtime=java17` on the deploy commands.

[WARNING]
====
Expand Down
9 changes: 1 addition & 8 deletions docs/src/main/asciidoc/native-reference.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -539,7 +539,7 @@ You can find instructions on how to quickly set up this application in this guid

This debugging guide has the following requirements:

* JDK 11 installed with `JAVA_HOME` configured appropriately
* JDK 17 installed with `JAVA_HOME` configured appropriately
* Apache Maven {maven-version}
* A working container runtime (Docker, podman)

Expand Down Expand Up @@ -590,13 +590,6 @@ quarkus.container-image.build=true
quarkus.container-image.group=test
----

[IMPORTANT]
====
Starting with 22.3, Mandrel does not provide a `-java11` version anymore.
Note, however, that this doesn't mean that you may no longer produce native executables with Mandrel for Java 11 projects.
You can still compile your Java 11 projects using OpenJDK 11 and produce native executables from the resulting Java 11 bytecode using the `-java17` Mandrel builder images.
====

=== First Debugging Steps

As a first step, change to the project directory and build the native executable for the application:
Expand Down

0 comments on commit 6f2d773

Please sign in to comment.