Guides

Run a Spring Boot app

Copy page

This guide explains how to create and deploy a Spring Boot web server. To run this example, follow these steps:

1. Install the kraft CLI tool and a container runtime engine, for example Docker.

2. Clone the examples repository and cd into the examples/java17-springboot3.2.x/ directory:

Code
 
git clone https://github.com/kraftcloud/examples
cd examples/java17-springboot3.2.x/

Make sure to log into Unikraft Cloud by setting your token and a metro close to you. This guide uses fra (Frankfurt, 🇩🇪):

Code
 
# Set Unikraft Cloud access token
export UKC_TOKEN=token
# Set metro to Frankfurt, DE
export UKC_METRO=fra

When done, invoke the following command to deploy this app on Unikraft Cloud:

Code
 
kraft cloud deploy -M 1024 -p 443:8080 .

The output shows the instance address and other details:

Code
 
[●] Deployed successfully!
 │
 ├────────── name: java17-springboot32x-qseeo
 ├────────── uuid: b081166d-a2a0-43af-982d-1aa17f06b5c4
 ├───────── state: running
 ├─────────── url: https://long-dust-si7xsngk.fra.unikraft.app
 ├───────── image: java17-springboot32x@sha256:cc2f2ad18ce8e36b8e8f4debee096fef7b0bb8b47762575a2ba5a9de8199c64a
 ├───── boot time: 153.97 ms
 ├──────── memory: 1024 MiB
 ├─────── service: long-dust-si7xsngk
 ├── private fqdn: java17-springboot32x-qseeo.internal
 ├──── private ip: 172.16.6.2
 └────────── args: /usr/lib/jvm/java-17-openjdk-amd64/bin/java -jar /usr/src/demo-0.0.1-SNAPSHOT.jar

In this case, the instance name is java17-springboot32x-qseeo and the address is https://long-dust-si7xsngk.fra.unikraft.app. They're different for each run.

Use curl to query the Spring Boot server's hello endpoint:

Code
 
curl https://long-dust-si7xsngk.fra.unikraft.app/hello

Code
 
Hello World!

When done, you can remove the instance:

Code
 
kraft cloud instance remove 

Customize your app

To customize the app, update the files in the repository, listed below:

• DemoApplication.java: the server
• Kraftfile: the Unikraft Cloud specification
• Dockerfile: the Docker-specified app filesystem

Lines in the Kraftfile have the following roles:

• spec: v0.6: The current Kraftfile specification version is 0.6.

• runtime: java:17: The Unikraft runtime kernel to use is Java.

• rootfs: ./Dockerfile: Build the app root filesystem using the Dockerfile.

• cmd: ["/usr/lib/jvm/java-17-openjdk-amd64/bin/java", "-jar", "/usr/src/demo-0.0.1-SNAPSHOT.jar"]: Use as the starting command of the instance.

Lines in the Dockerfile have the following roles:

• FROM scratch: Build the filesystem from the scratch container image, to create a base image.

• COPY DemoApplication.java src/main/java/com/example/demo/: Copy the server implementation file in the Docker filesystem.

The following options are available for customizing the app:

• If you only update the implementation in the DemoApplication.java source file, you don't need to make any other changes.

• If you create any new source files, copy them into the app filesystem by using the COPY command in the Dockerfile.

• More extensive changes may require extending the Dockerfile (see Dockerfile syntax reference).

Learn more

Use the --help option for detailed information on using Unikraft Cloud:

Code
 
kraft cloud --help

Or visit the CLI Reference.