Spring

HOME
Spring
How to dockerize Spring Microservice during Maven build?

March 30, 2023 / Last updated : April 2, 2023 Drona Spring

How to dockerize Spring Microservice during Maven build?

One can use the Spotify Docker plugin for Maven to build Docker images for your Spring microservice during the Maven build process. Here are the general steps:

Add the Spotify Docker plugin to your Maven project’s pom.xml file:



<build>
  <plugins>
    <plugin>
      <groupId>com.spotify</groupId>
      <artifactId>docker-maven-plugin</artifactId>
      <version>1.2.0</version>
      <configuration>
        <imageName>myapp:${project.version}</imageName>
        <dockerDirectory>src/main/docker</dockerDirectory>
        <resources>
          <resource>
            <targetPath>/</targetPath>
            <directory>${project.build.directory}</directory>
            <include>${project.build.finalName}.jar</include>
          </resource>
        </resources>
      </configuration>
    </plugin>
  </plugins>
</build>

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

<build>

<groupId>com.spotify</groupId>

<artifactId>docker-maven-plugin</artifactId>

<imageName>myapp:${project.version}</imageName>

<dockerDirectory>src/main/docker</dockerDirectory>

<directory>${project.build.directory}</directory>

<include>${project.build.finalName}.jar</include>

</resource>

</resources>

</configuration>

</plugin>

</plugins>

</build>

This configuration sets the image name to myapp with the version set to the Maven project version, and specifies the Dockerfile directory to be src/main/docker. It also includes the compiled JAR file as a resource to be copied into the Docker image.

Create a Dockerfile for your Spring microservice in the src/main/docker directory. Here is an example:



FROM openjdk:11-jre-slim
WORKDIR /app
COPY myapp.jar /app
CMD ["java", "-jar", "myapp.jar"]

1

2

3

4

5

6

7

8

FROM openjdk:11-jre-slim

WORKDIR /app

COPY myapp.jar /app

CMD ["java", "-jar", "myapp.jar"]

This Dockerfile uses an OpenJDK 11 image as a base, sets the working directory to /app, copies the compiled Spring application (here, myapp.jar) into the container’s /app directory, and specifies the command to run the application.

Build the Docker image during the Maven build process by running:



mvn clean package docker:build

1

2

3

4

mvn clean package docker:build

This command will build the Maven project, package the Spring application as a JAR file, and build a Docker image with the name and version specified in the pom.xml file.

Run the Docker container from the built image using the docker run command, as described in the previous answer.

That’s it! You now have a Dockerized Spring microservice built during the Maven build process. You can repeat these steps for each microservice in your application, and use tools like Docker Compose or Kubernetes to manage the containers.