Skip to content

jlink-image.adoc

Latest commit

 

History

History
195 lines (138 loc) · 6.26 KB

jlink-image.adoc

File metadata and controls

195 lines (138 loc) · 6.26 KB
Raw

Introduction

JDK 9 introduced the jlink command that supports assembling a set of modules and their dependencies into a custom runtime image. The helidon-maven-plugin has support for easily creating a custom runtime image for your Helidon application resulting in a smaller, better performing runtime.

In this guide you will learn how to build a custom runtime image locally on your machine, as well as how to build it in a Docker image.

What You Need

For this 10 minute tutorial, you will need the following:

Verify JDK

As noted in the prerequisites above, JDK 11 or newer is required.

$JAVA_HOME/bin/java --version

Creating a custom runtime image requires that the JDK modules are present as *.jmod files, and some distributions do not provide them by default. Check the jmods directory to ensure they are present:

ls $JAVA_HOME/jmods
Tip
OpenJDK on Linux
RPM based distributions provide *.jmod files in separate java-*-openjdk-jmods packages. Debian based distributions provide *.jmod files only in the openjdk-*-jdk-headless packages.

Generate the Project

Generate the project using the Helidon {flavor-uc} Quickstart Maven archetype.

mvn -U archetype:generate -DinteractiveMode=false \
    -DarchetypeGroupId=io.helidon.archetypes \
    -DarchetypeArtifactId=helidon-quickstart-{flavor-lc} \
    -DarchetypeVersion={helidon-version} \
    -DgroupId=io.helidon.examples \
    -DartifactId=helidon-quickstart-{flavor-lc} \
    -Dpackage=io.helidon.examples.quickstart.{flavor-lc}

The archetype generates a Maven project in your current directory (for example, helidon-quickstart-{flavor-lc}). Change into this directory and build.

cd helidon-quickstart-{flavor-lc}
mvn package

At this point you can run the application using the JVM:

java -jar target/helidon-quickstart-{flavor-lc}.jar

In another shell test an endpoint:

curl -X GET http://localhost:8080/greet

The application should respond with {"message":"Hello World!"}

Now stop the running application (by pressing Ctrl+C).

For more information about the Quickstart application and other endpoints it supports see the Helidon {flavor-uc} quickstart Guide.

Building a Custom Runtime Image

You can build a custom runtime image in 2 different ways:

  • Locally, on your desktop

  • Using Docker

Local Build

Build the custom runtime image using the jlink image profile:

mvn package -Pjlink-image
Tip
 This uses the helidon-maven-plugin to perform the custom image generation.

After the build completes it will report some statistics about the build including the reduction in image size.

The target/helidon-quickstart-{flavor-lc}-jri directory is a self contained custom image of your application. It contains your application, its runtime dependencies and the JDK modules it depends on. You can start your application using the provide start script:

./target/helidon-quickstart-{flavor-lc}-jri/bin/start

Class Data Sharing (CDS) Archive

Also included in the custom image is a Class Data Sharing (CDS) archive that improves your application’s startup performance and in-memory footprint. You can learn more about Class Data Sharing in the JDK documentation.

The CDS archive increases your image size to get these performance optimizations. It can be of significant size (tens of MB). The size of the CDS archive is reported at the end of the build output.

If you’d rather have a smaller image size (with a slightly increased startup time) you can skip the creation of the CDS archive by executing your build like this:

mvn package -Pjlink-image -Djlink.image.addClassDataSharingArchive=false

For more information on available configuration options see the helidon-maven-plugin documentation.

Multi-Stage Docker Build

To build a Docker image with a custom Java runtime image use the jlink Dockerfile included with the quickstart.

docker build -t helidon-quickstart-{flavor-lc}-jri -f Dockerfile.jlink .
Tip
 This does a full build inside the Docker container. The first time you run it, it will take a while because it is downloading all of the Maven dependencies and caching them in a Docker layer. Subsequent builds will be much faster as long as you don’t change the pom.xml file. If the pom is modified then the dependencies will be re-downloaded.

Start the application:

docker run --rm -p 8080:8080 helidon-quickstart-{flavor-lc}-jri:latest

You can exercise the application’s endpoints as before.

Using Custom Runtime Images

Custom runtime images are ideal for use when you want all of the runtime performance of the JDK JVM in a reasonably compact form.

For cases where absolute minimal startup time and image size are required, then consider using GraalVM Native Images.