Dockerfile for Spring Boot in Spring Boot - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of a Dockerfile in a Spring Boot project?

A Dockerfile defines the steps to create a Docker image that packages the Spring Boot application and its environment so it can run consistently anywhere.

beginner

Which base image is commonly used for building a Spring Boot Docker image?

OpenJDK base images like 'openjdk:17-jdk-slim' are commonly used because Spring Boot apps run on Java.

beginner

What command in a Dockerfile copies the Spring Boot jar file into the image?

The 'COPY' command copies files from your project into the Docker image, e.g., 'COPY target/app.jar app.jar'.

beginner

How do you specify the command to run the Spring Boot app inside the Docker container?

Use the 'ENTRYPOINT' or 'CMD' instruction with 'java -jar app.jar' to start the Spring Boot application.

intermediate

Why is it useful to use a multi-stage Dockerfile for Spring Boot?

Multi-stage builds separate building the jar and running it, making the final image smaller and faster to deploy.

Which Dockerfile instruction copies your Spring Boot jar into the image?

A COPY

B RUN

C ADD

D EXPOSE

COPY copies files from your local project into the Docker image.

What base image is best for running a Spring Boot app with Java 17?

A openjdk:17-jdk-slim

B node:latest

C python:3.12

D ubuntu:20.04

openjdk:17-jdk-slim provides Java 17 runtime needed for Spring Boot.

Which Dockerfile instruction sets the command to start the Spring Boot app?

A WORKDIR

B ENV

C CMD

D VOLUME

CMD or ENTRYPOINT defines the command to run inside the container.

Why use a multi-stage Dockerfile for Spring Boot?

A To build and run in one step

B To reduce final image size

C To add more layers

D To run multiple apps

Multi-stage builds keep the final image small by excluding build tools.

What does the EXPOSE instruction do in a Spring Boot Dockerfile?

A Sets environment variables

B Copies files

C Runs the app

D Declares the port the app listens on

EXPOSE tells Docker which port the container listens on.

Describe the key steps to create a Dockerfile for a Spring Boot application.

Think about how to package and run a Java app inside Docker.

Explain the benefits of using a multi-stage Dockerfile for Spring Boot projects.

Consider how to keep the Docker image small and efficient.

Practice

1. What is the main purpose of a Dockerfile in a Spring Boot project?

easy

A. To write the Java code for the Spring Boot application

B. To define how to package and run the Spring Boot app inside a container

C. To configure the database connection settings

D. To create unit tests for the Spring Boot app

Solution

1. Step 1: Understand the role of Dockerfile

   A Dockerfile contains instructions to build a Docker image that packages the app and its environment.

2. Step 2: Identify its use in Spring Boot

   For Spring Boot, it defines how to copy the app jar, expose ports, and run the app in a container.

3. Final Answer:

   To define how to package and run the Spring Boot app inside a container -> Option B

4. Quick Check:

   Dockerfile = Package & run app [OK]

Hint: Dockerfile builds container image for your app [OK]

Common Mistakes:

• Confusing Dockerfile with source code files
• Thinking Dockerfile configures app logic
• Assuming Dockerfile is for testing only

2. Which of the following is the correct syntax to copy the Spring Boot jar file into the Docker image in a Dockerfile?

easy

A. COPY /app.jar target/app.jar

B. MOVE target/app.jar /app.jar

C. ADD target/app.jar

D. COPY target/app.jar /app.jar

Solution

1. Step 1: Understand COPY command syntax

   The COPY command syntax is: COPY source_path destination_path inside the image.

2. Step 2: Apply to Spring Boot jar

   We copy the built jar from local 'target/app.jar' to '/app.jar' inside the image.

3. Final Answer:

   COPY target/app.jar /app.jar -> Option D

4. Quick Check:

   COPY source destination [OK]

Hint: COPY source then destination path [OK]

Common Mistakes:

• Using MOVE instead of COPY
• Missing destination path in ADD
• Reversing source and destination paths

3. Given this Dockerfile snippet:

FROM openjdk:17-jdk-slim
COPY target/app.jar /app.jar
EXPOSE 8080
ENTRYPOINT ["java", "-jar", "/app.jar"]

What happens when you run the built Docker image?

medium

A. The container runs but does not start the app

B. The container fails because EXPOSE is missing

C. The container runs the Spring Boot app on port 8080

D. The container runs the app but on port 80

Solution

1. Step 1: Analyze Dockerfile commands

   FROM sets base image with Java 17. COPY adds app.jar. EXPOSE 8080 declares port. ENTRYPOINT runs the jar.

2. Step 2: Understand container behavior

   When run, container starts Java app listening on port 8080 as declared.

3. Final Answer:

   The container runs the Spring Boot app on port 8080 -> Option C

4. Quick Check:

   ENTRYPOINT runs app, EXPOSE 8080 [OK]

Hint: ENTRYPOINT runs app; EXPOSE shows port [OK]

Common Mistakes:

• Thinking EXPOSE runs the app
• Assuming default port 80 without config
• Ignoring ENTRYPOINT command

4. You wrote this Dockerfile:

FROM openjdk:17-jdk-slim
COPY app.jar /app.jar
EXPOSE 8080
ENTRYPOINT ["java", "-jar", "/app.jar"]

But when running the container, it fails with 'file not found'. What is the likely cause?

medium

A. The jar file is not named 'app.jar' in the build folder

B. EXPOSE 8080 is missing

C. ENTRYPOINT syntax is incorrect

D. Base image openjdk:17-jdk-slim does not support Java

Solution

1. Step 1: Check COPY source path

   COPY expects a local file named 'app.jar' but likely the jar is named differently or in a different folder.

2. Step 2: Understand error cause

   If the jar is missing or misnamed, container cannot find '/app.jar' to run, causing failure.

3. Final Answer:

   The jar file is not named 'app.jar' in the build folder -> Option A

4. Quick Check:

   COPY source must match actual jar name [OK]

Hint: Check jar filename matches COPY source [OK]

Common Mistakes:

• Assuming EXPOSE affects file copying
• Miswriting ENTRYPOINT array syntax
• Blaming base image for missing file

5. You want to optimize your Spring Boot Dockerfile to use a smaller image and faster startup. Which Dockerfile snippet achieves this best?

hard

A. FROM openjdk:17-jre-slim
COPY target/app.jar /app.jar
EXPOSE 8080
ENTRYPOINT ["java", "-jar", "/app.jar"]

B. FROM alpine
COPY target/app.jar /app.jar
EXPOSE 8080
ENTRYPOINT ["java", "-jar", "/app.jar"]

C. FROM openjdk:17-jdk-slim
COPY target/app.jar /app.jar
EXPOSE 8080
ENTRYPOINT ["java", "-jar", "/app.jar"]

D. FROM openjdk:17-jdk
COPY target/app.jar /app.jar
EXPOSE 8080
ENTRYPOINT ["java", "-jar", "/app.jar"]

Solution

1. Step 1: Compare base images

   openjdk:17-jre-slim has only Java runtime, smaller than jdk images which include compilers.

2. Step 2: Evaluate options for size and startup

   Using jre-slim reduces image size and speeds startup. Alpine lacks Java by default, causing errors.

3. Final Answer:

   FROM openjdk:17-jre-slim COPY target/app.jar /app.jar EXPOSE 8080 ENTRYPOINT ["java", "-jar", "/app.jar"] -> Option A

4. Quick Check:

   Use JRE slim for smaller, faster images [OK]

Hint: Use JRE slim base image for smaller Docker images [OK]

Common Mistakes:

• Using full JDK image unnecessarily
• Choosing Alpine without Java setup
• Ignoring image size impact