Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revert Paketo Buildpacks build step back (now supports JDK 23) #22

Merged
merged 2 commits into from
Oct 17, 2024
Merged

Revert Paketo Buildpacks build step back (now supports JDK 23) #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dffcd68
Revert Paketo Buildpacks build step back (now supports JDK 23)
olyagpl Oct 14, 2024
0f6f3e9
Add Paketo Buildpacks test
olyagpl Oct 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/github-actions-spring-boot-webserver.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ jobs:
./build-jlink.sh
#

# Build dynamic image using Paketo Buildpacks
./mvnw -Pnative spring-boot:build-image

# Build dynamic image (Distroless Java Base)
./build-dynamic-image.sh
#
Expand Down
131 changes: 63 additions & 68 deletions native-image/spring-boot-webserver/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,65 @@ The `ENTRYPOINT` for the application would be `java` from the custom runtime.
```
Jlink shrank the container by **46MB**.

## **STEP 3**: Build a Native Image Locally and Run Inside a Container (Default Configuration)
## **STEP 3**: Build and Run a Native Image Inside a Container Using Paketo Buildpacks

You can also compile this Spring Boot application ahead of time with GraalVM Native Image and run it using Paketo Buildpacks container images.

### Explanation

Spring Boot supports building a native image in a container using the [Paketo Buildpack for Oracle](https://github.com/paketo-buildpacks/oracle) which provides Oracle GraalVM Native Image.

The Paketo builder pulls the [Jammy Tiny Stack image](https://github.com/paketo-buildpacks/builder-jammy-tiny) (Ubuntu distroless-like image) which contains no buildpacks.
Then you point the **builder** image to the **creator** image.
For this workshop, you point to the [Paketo Buildpack for Oracle](https://github.com/paketo-buildpacks/oracle), explicitly requesting the Native Image tool.

If you open the _pom.xml_ file, you see the `spring-boot-maven-plugin` declaration added for you:
```xml
<configuration>
<image>
<builder>paketobuildpacks/builder-jammy-buildpackless-tiny</builder>
<buildpacks>
<buildpack>paketobuildpacks/oracle</buildpack>
<buildpack>paketobuildpacks/java-native-image</buildpack>
</buildpacks>
</image>
</configuration>
```
When `java-native-image` is requested, the buildpack downloads Oracle GraalVM, which includes Native Image.
The [Paketo documentation provides several examples](https://paketo.io/docs/howto/java/#build-an-app-as-a-graalvm-native-image-application) that show you how to build applications with Native Image using buildpacks.

> Note that if you do not specify Oracle's buildpack, it will pull the default buildpack, which can result in reduced performance.

### Action

1. Build a native executable for this Spring application using the Paketo buildpack:
```bash
./mvnw -Pnative spring-boot:build-image
```

2. Once the build completes, a container image _0.0.1-SNAPSHOT_ should be available. Run it, mapping the ports:
```bash
docker run --rm -p8080:8080 docker.io/library/webserver:0.0.1-SNAPSHOT
```

The application is running from the native image inside a container. The container started in **0.031 seconds**.

3. Open a browser and navigate to [localhost:8080/](http://localhost:8080/). You see the GraalVM documentation pages served.

4. Return to the terminal and stop the running container by clicking CTRL+C.

5. Check the size of this container image:
```bash
docker images
```
The expected output is:
```
REPOSITORY TAG IMAGE ID CREATED SIZE
webserver 0.0.1-SNAPSHOT 0660806da4a2 44 years ago 163MB
```
The new container, tagged as _0.0.1-SNAPSHOT_, is **163MB**.

## **STEP 4**: Build a Native Image Locally and Run Inside a Container (Default Configuration)

In this step, you will create a native image with the default configuration on a host machine, and only run it inside a container.

Expand Down Expand Up @@ -195,7 +253,7 @@ Learn more in ["Distroless" Container Images](https://github.com/GoogleContainer
The expected size is **125M**.
Note that the static resources are "baked" into this native executable and added 44M to its size.

## **STEP 4**: Build a Size-Optimized Native Image Locally and Run Inside a Container
## **STEP 5**: Build a Size-Optimized Native Image Locally and Run Inside a Container

_This is where the fun begins._

Expand Down Expand Up @@ -281,7 +339,7 @@ The script _build-dynamic-image.sh_, available in this repository for your conve

The size decreased from **125M** (`webserver`) to **92M** (`webserver.dynamic-optimized`) by applying the file size optimization.

## **STEP 5**: Build a Size-Optimized Mostly Static Native Image Locally and Run Inside a Container
## **STEP 6**: Build a Size-Optimized Mostly Static Native Image Locally and Run Inside a Container

In this step, you will build a **mostly static** native image, with the file size optimization on, on a host machine, then package it into a container image that provides `glibc`, and run.

Expand Down Expand Up @@ -367,7 +425,7 @@ A separate Maven profile exists for this step:

The size of the mostly static native image (`webserver.mostly-static`) has not changed much, and is around **93MB**.

## **STEP 6**: Build a Size-Optimized Fully Static Native Image Locally and Run Inside a Container
## **STEP 7**: Build a Size-Optimized Fully Static Native Image Locally and Run Inside a Container

In this step, you will build a **fully static** native image, with the file size optimization on, on a host machine, then package it into a _scratch_ container.

Expand Down Expand Up @@ -467,7 +525,7 @@ A separate Maven profile exists for this step:

The size of the mostly static native image (`webserver.static`) has not changed, and is around **93MB**.

## **STEP 7**: Compress a Static Native Image with UPX and Run Inside a Container
## **STEP 8**: Compress a Static Native Image with UPX and Run Inside a Container

_What can you do next to reduce the size even more?_

Expand Down Expand Up @@ -533,69 +591,6 @@ It can significantly reduce the executable size, but note, that UPX loads the ex
The container size reduced dramatically to just **36.2MB**.
The application and container image's size have been shrunk to the minimum.

## **STEP 8**: (Optional) Build and Run a Native Image Inside a Container Using Paketo Buildpacks

You can also compile this Spring Boot application ahead of time with GraalVM Native Image and run it using Paketo Buildpacks container images.

> Prerequisite: [GraalVM for JDK 21](https://www.graalvm.org/downloads/). We recommend using [SDKMAN!](https://sdkman.io/). (For other download options, see [GraalVM Downloads](https://www.graalvm.org/downloads/).)
```bash
sdk install java 21-graal
```

### Explanation

Spring Boot supports building a native image in a container using the [Paketo Buildpack for Oracle](https://github.com/paketo-buildpacks/oracle) which provides Oracle GraalVM Native Image.

The Paketo builder pulls the [Jammy Tiny Stack image](https://github.com/paketo-buildpacks/builder-jammy-tiny) (Ubuntu distroless-like image) which contains no buildpacks.
Then you point the **builder** image to the **creator** image.
For this workshop, you point to the [Paketo Buildpack for Oracle](https://github.com/paketo-buildpacks/oracle), explicitly requesting the Native Image tool.

If you open the _pom.xml_ file, you see the `spring-boot-maven-plugin` declaration added for you:
```xml
<configuration>
<image>
<builder>paketobuildpacks/builder-jammy-buildpackless-tiny</builder>
<buildpacks>
<buildpack>paketobuildpacks/oracle</buildpack>
<buildpack>paketobuildpacks/java-native-image</buildpack>
</buildpacks>
</image>
</configuration>
```
When `java-native-image` is requested, the buildpack downloads Oracle GraalVM, which includes Native Image.
The [Paketo documentation provides several examples](https://paketo.io/docs/howto/java/#build-an-app-as-a-graalvm-native-image-application) that show you how to build applications with Native Image using buildpacks.

> Note that if you do not specify Oracle's buildpack, it will pull the default buildpack, which can result in reduced performance.

### Action

1. Build a native executable for this Spring application using the Paketo buildpack:
```bash
./mvnw -Pnative spring-boot:build-image
```

2. Once the build completes, a container image _0.0.1-SNAPSHOT_ should be available. Run it, mapping the ports:
```bash
docker run --rm -p8080:8080 docker.io/library/webserver:0.0.1-SNAPSHOT
```

The application is running from the native image inside a container. The container started in **0.031 seconds**.

3. Open a browser and navigate to [localhost:8080/](http://localhost:8080/). You see the GraalVM documentation pages served.

4. Return to the terminal and stop the running container by clicking CTRL+C.

5. Check the size of this container image:
```bash
docker images
```
The expected output is:
```
REPOSITORY TAG IMAGE ID CREATED SIZE
webserver 0.0.1-SNAPSHOT 0660806da4a2 44 years ago 163MB
```
The new container, tagged as _0.0.1-SNAPSHOT_, is **163MB**.

## **STEP 9**: (Optional) Clean up

To clean up all images, run the `./clean.sh` script provided for that purpose.
Expand Down
Loading