Workshop Setup

This file can be used to check that you have correctly installed everything that you need for the workshop.

Java

You will need Java 17 with GraalVM to run this workshop. Optionally, you can also use Java 8 with earlier parts of the workshop as long as you can switch to Java 17 easily.

We recommend using SDKMAN! to manage installed Java versions, but you're free to use whatever you prefer as long as Java 17 is available. On Windows, you will need bash to use SDKMAN! (Git Bash, MinGW, Cygwin, WSL, etc.), if you don't want to install it you can try CHOCOLATEY! too.

SDKMAN!

The following instructions can be used if you are using SDKMAN!

1. Install SDKMAN! for your system by following instructions at https://sdkman.io/
2. Install Java 8 by typing sdk install java 8.0.362-librca
3. Install Java 17 by typing sdk install java 22.3.r17-nik

Check that you can use Java 8

$ sdk use java 8.0.362-librca
$ java -version
openjdk version "1.8.0_362"
OpenJDK Runtime Environment (build 1.8.0_362-b09)
OpenJDK 64-Bit Server VM (build 25.362-b09, mixed mode)

Check that you can use Java 17

$ sdk use java 22.3.r17-nik
$ java -version
openjdk version "17.0.5" 2022-10-18 LTS
OpenJDK Runtime Environment GraalVM 22.3.0 (build 17.0.5+8-LTS)
OpenJDK 64-Bit Server VM GraalVM 22.3.0 (build 17.0.5+8-LTS, mixed mode, sharing)

Check that you can use GraalVM

$ native-image --version
GraalVM 22.3.0 Java 17 CE (Java Version 17.0.5+8-LTS)

CHOCOLATEY! (Windows)

The following instructions can be used if you are using CHOCOLATEY!

1. Install CHOCOLATEY! for your system by following instructions at https://community.chocolatey.org/
2. Install Java 8 by typing PS C:\> choco install liberica8jdk (in PowerShell as Administrator)
3. Install Java 17 by typing PS C:\> choco install graalvm-java17 (in PowerShell as Administrator)

Check that you can use Java 8 and GraalVM 17

1. Open System Properties
2. Click Environment Variables... and change the PATH and JAVA_HOME System Variables to use the right JDK/GraalVM paths
3. Open a new PowerShell window and check the Java version

PS C:\> java -version
openjdk version "17.0.6" 2023-01-17
OpenJDK Runtime Environment GraalVM CE 22.3.1 (build 17.0.6+10-jvmci-22.3-b13)
OpenJDK 64-Bit Server VM GraalVM CE 22.3.1 (build 17.0.6+10-jvmci-22.3-b13, mixed mode, sharing)

Without SDKMAN! or CHOCOLATEY!

If you prefer not to use SKDMAN! or CHOCOLATEY! you can install Java and GraalVM whichever way you're most comfortable. As long as you have Java 17 and the native-image tool install, you should be fine.

Please check your installation by checking the output of java -version and native-image --version:

$ java -version
openjdk version "17.0.5" 2022-10-18 LTS
OpenJDK Runtime Environment GraalVM 22.3.0 (build 17.0.5+8-LTS)
OpenJDK 64-Bit Server VM GraalVM 22.3.0 (build 17.0.5+8-LTS, mixed mode, sharing)

$ native-image --version
GraalVM 22.3.0 Java 17 CE (Java Version 17.0.5+8-LTS)

If you get an error saying that native-image is not found, e.g.:

command not found: native-image

This might not be a big problem, it might only mean that your GraalVM installation does not have native-image pre-installed. Try to install it with the GraalVM Updater:

$ gu install native-image

NOTE: On Windows, GraalVM installation contains the gu.cmd command. Depending on the terminal you use, it can be executed as just gu or gu.cmd.

And check the version again:

$ native-image --version

Maven

This workshop uses mvnw so you shouldn't need to install Maven directly.

To check that Maven works run the following command from this directory.

On Linux/Mac

$ ./mvnw --version

On Windows

$ mvnw.cmd --version

If you want to ensure your local Maven cache has most of the files we'll need, you can build the pom files in this directory:

$ ./mvnw package

You should see a "success" message after these command:

[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------

Docker Compose

We will be using Docker Compose to setup run things like Postgres which we will need for the workshop. We recommend Docker Desktop if possible, but any Docker installation that can run docker compose should work fine.

Docker Desktop is free for educational purposes.

Please install Docker from https://www.docker.com or using your favorite open source distribution.

To check docker is running, you can run:

$ docker run --rm hello-world

To check docker compose is working, run the following from this directory:

$ docker compose -f docker-compose-hello.yml up

Once you see the "hello world" output, you can destroy the containers using:

$ docker compose -f docker-compose-hello.yml down

TIP: Depending on your installation, you might need to use the command docker-compose rather than docker compose.

If the hello world example works, then you can try starting the full docker compose configuration that we'll be using:

$ docker compose up

NOTE: it will take some time to initially start the containers

Check that the following links work:

http://localhost:9090 (Prometheus) http://localhost:3000 (Grafana)

If everything works you can hit ctrl-c to stop docker compose and you can destroy the containers using:

$ docker compose down

HTTPie

We'll need to make some REST calls to our application. You can use whatever tool you like, but if you have no preference we recommend HTTPie.

You can install it from https://httpie.io/

IDE

You can use any Java IDE you like to work with the code, just check that it can work with Maven projects.

Please import the dog-service project.