Using jlink and jdeps to build docker image by cunhazera · Pull Request #526 · Open-J-Proxy/ojp

cunhazera · 2026-05-16T19:23:57Z

No description provided.

rrobetti

@cunhazera this PR has to alter the https://github.com/Open-J-Proxy/ojp/blob/main/.github/workflows/main.yml
Specifically how the docker image is built and run for tests, steps:
Build OJP Server Docker image
Start OJP Server container

rrobetti · 2026-06-03T15:31:16Z

-
 # Step 1: Download open source JDBC drivers
 echo -e "${GREEN}Step 1: Downloading open source JDBC drivers...${NC}"
+bash "$SCRIPT_DIR/download-drivers.sh" "$SCRIPT_DIR/ojp-libs"


We should not download drivers in the script that builds the docker image. The script that builds the image only builds the image, nothing else. We no longer do "batteries included" approach. The user must add the drivers they want to use, the download-drivers.sh is just a helper.

Copilot

Pull request overview

This PR switches the ojp-server Docker image build from Jib to a multi-stage Dockerfile that uses jlink to produce a slimmer custom JRE, and adds an integration test to ensure the locally-built image starts successfully.

Changes:

Add a multi-stage ojp-server/Dockerfile that builds a custom Alpine JRE via jlink and runs the shaded server JAR.
Replace the Jib-based Maven Docker build with an exec-maven-plugin docker build in pre-integration-test, and add a Failsafe IT that starts the built image.
Update ojp-server Docker documentation and refactor docker-build.sh to build/push using the new Dockerfile flow.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
`ojp-server/src/test/java/org/openjproxy/grpc/server/OjpDockerImageIT.java`	New integration test that starts the locally-built Docker image via `OjpContainer`.
`ojp-server/README.md`	Documents the new Dockerfile-based build/push flow and how to verify via Maven.
`ojp-server/pom.xml`	Removes Jib config, adds Docker build execution, and configures Failsafe ITs with an image version property.
`ojp-server/Dockerfile`	New multi-stage Dockerfile using `jlink` to create a custom JRE and run the shaded JAR.
`ojp-server/docker-build.sh`	Reworked helper script to download drivers, build the shaded JAR, and `docker build`/`docker push`.

+            <!-- Docker image: build via Dockerfile (multi-stage jlink image) -->
            <plugin>
-                <groupId>com.google.cloud.tools</groupId>
-                <artifactId>jib-maven-plugin</artifactId>
-                <version>${jib.plugin.version}</version>
+                <groupId>org.codehaus.mojo</groupId>
+                <artifactId>exec-maven-plugin</artifactId>
+                <version>3.1.0</version>


+    void localImageStartsSuccessfully() {
+        String version = System.getProperty("ojp.image.version");
+        DockerImageName image = DockerImageName.parse("rrobetti/ojp:" + version)


+### Run locally
+
+```bash
+docker run -p 1059:1059 rrobetti/ojp:0.4.17-SNAPSHOT


@@ -21,5 +39,12 @@ docker run -d \
  rrobetti/ojp:0.4.21-beta


 ## Docker Image

-### Build docker image locally
+The image is a custom Alpine JRE built with `jlink` (only the modules required by OJP), bringing the final image size to **128MB**.


 COMMAND="${1:-build}"
+SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"


+# Step 4: Build Docker image
+echo -e "${GREEN}Step 3: Building Docker image ${IMAGE}...${NC}"
+docker build -t "$IMAGE" "$SCRIPT_DIR"

 if [ $? -ne 0 ]; then
-    echo ""
-    echo -e "${RED}Failed to download drivers!${NC}"
+    echo -e "${RED}Docker build failed!${NC}"
    exit 1
 fi


…vers via download-drivers.sh

…accordingly

rrobetti · 2026-06-05T10:26:41Z

@cunhazera workflow failed, please check.

cunhazera · 2026-06-05T18:21:07Z

@rrobetti pushed a new commit.

cunhazera · 2026-06-05T20:52:57Z

@rrobetti pushed a new commit.

Not good enough. On it.

cunhazera · 2026-06-06T15:34:38Z

@rrobetti looks like an unrelated error happened. Can you please check?

rrobetti · 2026-06-06T16:06:25Z

@cunhazera don't worry about [Main CI / notify-integration (pull_request)] this is expected as per branches should not trigger external framework integration tests, the relevant tests are all passing now.
Please address my other small comments.

cunhazera · 2026-06-06T23:59:59Z

Please address my other small comments.

@rrobetti sorry, which comments are still left behind?

I think I addressed all of them, but I think I'm missing something here.

cunhazera · 2026-06-07T04:33:48Z

Please address my other small comments.

@rrobetti sorry, which comments are still left behind?

I think I addressed all of them, but I think I'm missing something here.

I just replaced jib in other workflows by docker commands. Will need some help to test it.

rrobetti · 2026-06-06T12:38:03Z

      - name: Build OJP Server Docker image
-        run: mvn jib:dockerBuild -pl ojp-server -Dgpg.skip=true
+        run: |
+          VERSION=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout -pl ojp-server)


@cunhazera can't this version be some sort of a global variable? the same code to get it is present in a few places.

rrobetti · 2026-06-06T12:39:48Z

 ##############################################################################
 # OJP Docker Build Helper
 #
-# This script automates the Docker image build process with open source


@cunhazera why did you remove all these comments? I found them usefull

rrobetti · 2026-06-06T12:40:01Z

 # Commands:
 #   build  - Build Docker image locally (default)
 #   push   - Build and push Docker image to registry (requires docker login)
-#


@cunhazera same, why remove?

rrobetti · 2026-06-06T12:40:45Z

-#
 ##############################################################################

-set -e  # Exit on error


@cunhazera keep the comments.

rrobetti · 2026-06-06T12:40:55Z

-set -e  # Exit on error
+set -e

-# Color output


@cunhazera keep the comment

rrobetti · 2026-06-06T12:41:05Z

 GREEN='\033[0;32m'
 YELLOW='\033[1;33m'
 BLUE='\033[0;34m'
-NC='\033[0m' # No Color


@cunhazera keep the comment.

rrobetti · 2026-06-06T12:41:20Z

-NC='\033[0m' # No Color
+NC='\033[0m'

-# Default command


@cunhazera keep the comment

rrobetti · 2026-06-06T12:44:29Z

+COPY ojp-libs/ /opt/ojp/ojp-libs/
+COPY target/ojp-server-*-shaded.jar /opt/ojp/ojp-server.jar
+
+EXPOSE 1059


@cunhazera what about the prometheus port 9159 ? Also the ports can be configured in OJP server, how can we handle that ? https://github.com/Open-J-Proxy/ojp/blob/main/documents/configuration/ojp-server-configuration.md

What I suggest: defaulting these values with the possibility to override them via -e in docker run.
That handles the users the responsibility to sync all the config values.

Now I think we should figure out if reducing the image size (what this PR accomplishes) is worthy, considering that our image generation strategy is changing drastically and also giving users one more step to set things up.

rrobetti · 2026-06-07T06:13:40Z

@cunhazera apologies, forgot to submit the comments, they are visible now.

… var for version in workflow

sonarqubecloud · 2026-06-08T00:55:32Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

cunhazera · 2026-06-08T01:03:35Z

@rrobetti thanks for these comments! The new commit should address all of them!

rrobetti · 2026-06-08T06:53:14Z

+COPY ojp-libs/ /opt/ojp/ojp-libs/
+COPY target/ojp-server-*-shaded.jar /opt/ojp/ojp-server.jar
+
+EXPOSE ${OJP_SERVER_PORT} ${OJP_PROMETHEUS_PORT}


@cunhazera we do not really need this right? can we remove EXPOSE and the variables entirelly? K8S for example ignores EXPOSE anyway.
The operator will define the ports via docker run command

rrobetti · 2026-06-08T06:53:43Z

+# the image metadata will always list 1059 and 9159 regardless of what is
+# passed at runtime. When overriding ports, the -p mapping must match the
+# -e value — Docker does not update EXPOSE dynamically.
+ENV OJP_SERVER_PORT=1059


@cunhazera if we remove EXPOSE, these variables are no longer needed. The application will set these defaults, there is no need to do it here. I am leaning towards removing from here to simplify.

rrobetti · 2026-06-08T06:54:55Z

+
+# Stage 2: Runtime image
+FROM alpine:3.21
+


@cunhazera add a user to run OJP, currently running as root.

RUN addgroup -S ojp && adduser -S ojp -G ojp

rrobetti · 2026-06-08T07:09:11Z

+ENV JAVA_HOME=/opt/java
+ENV PATH="${JAVA_HOME}/bin:${PATH}"
+
+# Default ports for the gRPC server and Prometheus metrics endpoint.


@cunhazera we can remove this comment if the variables are removed.

rrobetti · 2026-06-08T07:10:59Z

+# -e value — Docker does not update EXPOSE dynamically.
+ENV OJP_SERVER_PORT=1059
+ENV OJP_PROMETHEUS_PORT=9159
+


@cunhazera to run as ojp user we need
ENV JAVA_HOME=/opt/java
ENV PATH="${JAVA_HOME}/bin:${PATH}"

rrobetti · 2026-06-08T07:11:24Z

+COPY target/ojp-server-*-shaded.jar /opt/ojp/ojp-server.jar
+
+EXPOSE ${OJP_SERVER_PORT} ${OJP_PROMETHEUS_PORT}
+


@cunhazera add
USER ojp

rrobetti · 2026-06-08T07:13:30Z

@cunhazera please check my latest comments, I know I increased the scope of this PR a little by asking you to change to use a ojp user instead of root, but I believe it is a small change that delivers production operational grade level, so please add the change.

cunhazera · 2026-06-08T11:09:56Z

@cunhazera please check my latest comments, I know I increased the scope of this PR a little by asking you to change to use a ojp user instead of root, but I believe it is a small change that delivers production operational grade level, so please add the change.

Sure, they all make sense.

cunhazera added 2 commits May 16, 2026 16:23

using jlink and jdeps to build docker image

70868eb

conflicts

7ac36fa

cunhazera marked this pull request as draft May 16, 2026 21:53

cunhazera added 4 commits May 16, 2026 22:51

changing the image size, considering the image that runs the app

1e54774

Merge branch 'Open-J-Proxy:main' into docker

bd1fa78

Running testcontainers and changing sh file to build new docker image

2ec385d

adding docker login

90f7906

cunhazera changed the title ~~WIP using jlink and jdeps to build docker image~~ Using jlink and jdeps to build docker image Jun 3, 2026

cunhazera marked this pull request as ready for review June 3, 2026 14:50

Merge branch 'main' into docker

6d26487

rrobetti requested changes Jun 3, 2026

View reviewed changes

rrobetti requested a review from Copilot June 3, 2026 20:47

Copilot started reviewing on behalf of rrobetti June 3, 2026 20:47 View session

Copilot AI reviewed Jun 3, 2026

View reviewed changes

cunhazera added 2 commits June 3, 2026 21:55

Rolling back from batteries included approach, letting users pick dri…

13dde4d

…vers via download-drivers.sh

Addressing PR comments in sh file, docker IT, CI and updating readme …

dbcd5be

…accordingly

creating ojp-server during build

934a139

cunhazera added 2 commits June 5, 2026 21:09

using opt-in strategy to run docker

28e9d86

removing mkdir command

c1d5665

fully replacing jib by docker commands

849ffaa

rrobetti requested changes Jun 7, 2026

View reviewed changes

adding comments back to sh file, handling ports in dockerfile, adding…

1e2f06a

… var for version in workflow

rrobetti requested changes Jun 8, 2026

View reviewed changes

		COMMAND="${1:-build}"
		SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"

		COPY target/ojp-server-*-shaded.jar /opt/ojp/ojp-server.jar

		EXPOSE ${OJP_SERVER_PORT} ${OJP_PROMETHEUS_PORT}

Conversation

cunhazera commented May 16, 2026

Uh oh!

rrobetti left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

rrobetti commented Jun 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cunhazera commented Jun 5, 2026

Uh oh!

cunhazera commented Jun 5, 2026

Uh oh!

cunhazera commented Jun 6, 2026

Uh oh!

rrobetti commented Jun 6, 2026

Uh oh!

cunhazera commented Jun 6, 2026

Uh oh!

cunhazera commented Jun 7, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rrobetti commented Jun 7, 2026

Uh oh!

sonarqubecloud Bot commented Jun 8, 2026

Quality Gate passed

Uh oh!

cunhazera commented Jun 8, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rrobetti commented Jun 8, 2026

Uh oh!

cunhazera commented Jun 8, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

rrobetti commented Jun 5, 2026 •

edited

Loading