Skip to content

Commit af6c820

Browse files
gsmetgsmet
committed
Update getting-started Dockerfiles
1 parent 6548a89 commit af6c820

File tree

4 files changed

+153
-61
lines changed

4 files changed

+153
-61
lines changed

‎getting-started/src/main/docker/Dockerfile.jvm‎

Lines changed: 70 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -14,41 +14,84 @@
1414
# docker run -i --rm -p 8080:8080 quarkus/getting-started-jvm
1515
#
1616
# If you want to include the debug port into your docker image
17-
# you will have to expose the debug port (default 5005) like this : EXPOSE 8080 5050
17+
# you will have to expose the debug port (default 5005 being the default) like this : EXPOSE 8080 5005.
18+
# Additionally you will have to set -e JAVA_DEBUG=true and -e JAVA_DEBUG_PORT=*:5005
19+
# when running the container
1820
#
1921
# Then run the container using :
2022
#
21-
# docker run -i --rm -p 8080:8080 -p 5005:5005 -e JAVA_ENABLE_DEBUG="true" quarkus/getting-started-jvm
23+
# docker run -i --rm -p 8080:8080 quarkus/getting-started-jvm
24+
#
25+
# This image uses the `run-java.sh` script to run the application.
26+
# This scripts computes the command line to execute your Java application, and
27+
# includes memory/GC tuning.
28+
# You can configure the behavior using the following environment properties:
29+
# - JAVA_OPTS: JVM options passed to the `java` command (example: "-verbose:class")
30+
# - JAVA_OPTS_APPEND: User specified Java options to be appended to generated options
31+
# in JAVA_OPTS (example: "-Dsome.property=foo")
32+
# - JAVA_MAX_MEM_RATIO: Is used when no `-Xmx` option is given in JAVA_OPTS. This is
33+
# used to calculate a default maximal heap memory based on a containers restriction.
34+
# If used in a container without any memory constraints for the container then this
35+
# option has no effect. If there is a memory constraint then `-Xmx` is set to a ratio
36+
# of the container available memory as set here. The default is `50` which means 50%
37+
# of the available memory is used as an upper boundary. You can skip this mechanism by
38+
# setting this value to `0` in which case no `-Xmx` option is added.
39+
# - JAVA_INITIAL_MEM_RATIO: Is used when no `-Xms` option is given in JAVA_OPTS. This
40+
# is used to calculate a default initial heap memory based on the maximum heap memory.
41+
# If used in a container without any memory constraints for the container then this
42+
# option has no effect. If there is a memory constraint then `-Xms` is set to a ratio
43+
# of the `-Xmx` memory as set here. The default is `25` which means 25% of the `-Xmx`
44+
# is used as the initial heap size. You can skip this mechanism by setting this value
45+
# to `0` in which case no `-Xms` option is added (example: "25")
46+
# - JAVA_MAX_INITIAL_MEM: Is used when no `-Xms` option is given in JAVA_OPTS.
47+
# This is used to calculate the maximum value of the initial heap memory. If used in
48+
# a container without any memory constraints for the container then this option has
49+
# no effect. If there is a memory constraint then `-Xms` is limited to the value set
50+
# here. The default is 4096MB which means the calculated value of `-Xms` never will
51+
# be greater than 4096MB. The value of this variable is expressed in MB (example: "4096")
52+
# - JAVA_DIAGNOSTICS: Set this to get some diagnostics information to standard output
53+
# when things are happening. This option, if set to true, will set
54+
# `-XX:+UnlockDiagnosticVMOptions`. Disabled by default (example: "true").
55+
# - JAVA_DEBUG: If set remote debugging will be switched on. Disabled by default (example:
56+
# true").
57+
# - JAVA_DEBUG_PORT: Port used for remote debugging. Defaults to 5005 (example: "8787").
58+
# - CONTAINER_CORE_LIMIT: A calculated core limit as described in
59+
# https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt. (example: "2")
60+
# - CONTAINER_MAX_MEMORY: Memory limit given to the container (example: "1024").
61+
# - GC_MIN_HEAP_FREE_RATIO: Minimum percentage of heap free after GC to avoid expansion.
62+
# (example: "20")
63+
# - GC_MAX_HEAP_FREE_RATIO: Maximum percentage of heap free after GC to avoid shrinking.
64+
# (example: "40")
65+
# - GC_TIME_RATIO: Specifies the ratio of the time spent outside the garbage collection.
66+
# (example: "4")
67+
# - GC_ADAPTIVE_SIZE_POLICY_WEIGHT: The weighting given to the current GC time versus
68+
# previous GC times. (example: "90")
69+
# - GC_METASPACE_SIZE: The initial metaspace size. (example: "20")
70+
# - GC_MAX_METASPACE_SIZE: The maximum metaspace size. (example: "100")
71+
# - GC_CONTAINER_OPTIONS: Specify Java GC to use. The value of this variable should
72+
# contain the necessary JRE command-line options to specify the required GC, which
73+
# will override the default of `-XX:+UseParallelGC` (example: -XX:+UseG1GC).
74+
# - HTTPS_PROXY: The location of the https proxy. (example: "[email protected]:8080")
75+
# - HTTP_PROXY: The location of the http proxy. (example: "[email protected]:8080")
76+
# - NO_PROXY: A comma separated lists of hosts, IP addresses or domains that can be
77+
# accessed directly. (example: "foo.example.com,bar.example.com")
2278
#
2379
###
24-
FROM registry.access.redhat.com/ubi8/ubi-minimal:8.3
80+
FROM registry.access.redhat.com/ubi8/openjdk-17:1.19
81+
82+
ENV LANGUAGE='en_US:en'
2583

26-
ARG JAVA_PACKAGE=java-17-openjdk-headless
27-
ARG RUN_JAVA_VERSION=1.3.8
28-
ENV LANG='en_US.UTF-8' LANGUAGE='en_US:en'
29-
# Install java and the run-java script
30-
# Also set up permissions for user `1001`
31-
RUN microdnf install curl ca-certificates ${JAVA_PACKAGE} \
32-
&& microdnf update \
33-
&& microdnf clean all \
34-
&& mkdir /deployments \
35-
&& chown 1001 /deployments \
36-
&& chmod "g+rwX" /deployments \
37-
&& chown 1001:root /deployments \
38-
&& curl https://repo1.maven.org/maven2/io/fabric8/run-java-sh/${RUN_JAVA_VERSION}/run-java-sh-${RUN_JAVA_VERSION}-sh.sh -o /deployments/run-java.sh \
39-
&& chown 1001 /deployments/run-java.sh \
40-
&& chmod 540 /deployments/run-java.sh \
41-
&& echo "securerandom.source=file:/dev/urandom" >> /etc/alternatives/jre/lib/security/java.security
4284

43-
# Configure the JAVA_OPTIONS, you can add -XshowSettings:vm to also display the heap size.
44-
ENV JAVA_OPTIONS="-Dquarkus.http.host=0.0.0.0 -Djava.util.logging.manager=org.jboss.logmanager.LogManager"
4585
# We make four distinct layers so if there are application changes the library layers can be re-used
46-
COPY --chown=1001 target/quarkus-app/lib/ /deployments/lib/
47-
COPY --chown=1001 target/quarkus-app/*.jar /deployments/
48-
COPY --chown=1001 target/quarkus-app/app/ /deployments/app/
49-
COPY --chown=1001 target/quarkus-app/quarkus/ /deployments/quarkus/
86+
COPY --chown=185 target/quarkus-app/lib/ /deployments/lib/
87+
COPY --chown=185 target/quarkus-app/*.jar /deployments/
88+
COPY --chown=185 target/quarkus-app/app/ /deployments/app/
89+
COPY --chown=185 target/quarkus-app/quarkus/ /deployments/quarkus/
5090

5191
EXPOSE 8080
52-
USER 1001
92+
USER 185
93+
ENV JAVA_OPTS_APPEND="-Dquarkus.http.host=0.0.0.0 -Djava.util.logging.manager=org.jboss.logmanager.LogManager"
94+
ENV JAVA_APP_JAR="/deployments/quarkus-run.jar"
95+
96+
ENTRYPOINT [ "/opt/jboss/container/java/run/run-java.sh" ]
5397

54-
ENTRYPOINT [ "/deployments/run-java.sh" ]

‎getting-started/src/main/docker/Dockerfile.legacy-jar‎

Lines changed: 67 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#
44
# Before building the container image run:
55
#
6-
# ./mvnw package -Dquarkus.package.type=legacy-jar
6+
# ./mvnw package -Dquarkus.package.jar.type=legacy-jar
77
#
88
# Then, build the image with:
99
#
@@ -14,38 +14,80 @@
1414
# docker run -i --rm -p 8080:8080 quarkus/getting-started-legacy-jar
1515
#
1616
# If you want to include the debug port into your docker image
17-
# you will have to expose the debug port (default 5005) like this : EXPOSE 8080 5050
17+
# you will have to expose the debug port (default 5005 being the default) like this : EXPOSE 8080 5005.
18+
# Additionally you will have to set -e JAVA_DEBUG=true and -e JAVA_DEBUG_PORT=*:5005
19+
# when running the container
1820
#
1921
# Then run the container using :
2022
#
21-
# docker run -i --rm -p 8080:8080 -p 5005:5005 -e JAVA_ENABLE_DEBUG="true" quarkus/getting-started-legacy-jar
23+
# docker run -i --rm -p 8080:8080 quarkus/getting-started-legacy-jar
24+
#
25+
# This image uses the `run-java.sh` script to run the application.
26+
# This scripts computes the command line to execute your Java application, and
27+
# includes memory/GC tuning.
28+
# You can configure the behavior using the following environment properties:
29+
# - JAVA_OPTS: JVM options passed to the `java` command (example: "-verbose:class")
30+
# - JAVA_OPTS_APPEND: User specified Java options to be appended to generated options
31+
# in JAVA_OPTS (example: "-Dsome.property=foo")
32+
# - JAVA_MAX_MEM_RATIO: Is used when no `-Xmx` option is given in JAVA_OPTS. This is
33+
# used to calculate a default maximal heap memory based on a containers restriction.
34+
# If used in a container without any memory constraints for the container then this
35+
# option has no effect. If there is a memory constraint then `-Xmx` is set to a ratio
36+
# of the container available memory as set here. The default is `50` which means 50%
37+
# of the available memory is used as an upper boundary. You can skip this mechanism by
38+
# setting this value to `0` in which case no `-Xmx` option is added.
39+
# - JAVA_INITIAL_MEM_RATIO: Is used when no `-Xms` option is given in JAVA_OPTS. This
40+
# is used to calculate a default initial heap memory based on the maximum heap memory.
41+
# If used in a container without any memory constraints for the container then this
42+
# option has no effect. If there is a memory constraint then `-Xms` is set to a ratio
43+
# of the `-Xmx` memory as set here. The default is `25` which means 25% of the `-Xmx`
44+
# is used as the initial heap size. You can skip this mechanism by setting this value
45+
# to `0` in which case no `-Xms` option is added (example: "25")
46+
# - JAVA_MAX_INITIAL_MEM: Is used when no `-Xms` option is given in JAVA_OPTS.
47+
# This is used to calculate the maximum value of the initial heap memory. If used in
48+
# a container without any memory constraints for the container then this option has
49+
# no effect. If there is a memory constraint then `-Xms` is limited to the value set
50+
# here. The default is 4096MB which means the calculated value of `-Xms` never will
51+
# be greater than 4096MB. The value of this variable is expressed in MB (example: "4096")
52+
# - JAVA_DIAGNOSTICS: Set this to get some diagnostics information to standard output
53+
# when things are happening. This option, if set to true, will set
54+
# `-XX:+UnlockDiagnosticVMOptions`. Disabled by default (example: "true").
55+
# - JAVA_DEBUG: If set remote debugging will be switched on. Disabled by default (example:
56+
# true").
57+
# - JAVA_DEBUG_PORT: Port used for remote debugging. Defaults to 5005 (example: "8787").
58+
# - CONTAINER_CORE_LIMIT: A calculated core limit as described in
59+
# https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt. (example: "2")
60+
# - CONTAINER_MAX_MEMORY: Memory limit given to the container (example: "1024").
61+
# - GC_MIN_HEAP_FREE_RATIO: Minimum percentage of heap free after GC to avoid expansion.
62+
# (example: "20")
63+
# - GC_MAX_HEAP_FREE_RATIO: Maximum percentage of heap free after GC to avoid shrinking.
64+
# (example: "40")
65+
# - GC_TIME_RATIO: Specifies the ratio of the time spent outside the garbage collection.
66+
# (example: "4")
67+
# - GC_ADAPTIVE_SIZE_POLICY_WEIGHT: The weighting given to the current GC time versus
68+
# previous GC times. (example: "90")
69+
# - GC_METASPACE_SIZE: The initial metaspace size. (example: "20")
70+
# - GC_MAX_METASPACE_SIZE: The maximum metaspace size. (example: "100")
71+
# - GC_CONTAINER_OPTIONS: Specify Java GC to use. The value of this variable should
72+
# contain the necessary JRE command-line options to specify the required GC, which
73+
# will override the default of `-XX:+UseParallelGC` (example: -XX:+UseG1GC).
74+
# - HTTPS_PROXY: The location of the https proxy. (example: "[email protected]:8080")
75+
# - HTTP_PROXY: The location of the http proxy. (example: "[email protected]:8080")
76+
# - NO_PROXY: A comma separated lists of hosts, IP addresses or domains that can be
77+
# accessed directly. (example: "foo.example.com,bar.example.com")
2278
#
2379
###
24-
FROM registry.access.redhat.com/ubi8/ubi-minimal:8.3
80+
FROM registry.access.redhat.com/ubi8/openjdk-17:1.19
81+
82+
ENV LANGUAGE='en_US:en'
2583

26-
ARG JAVA_PACKAGE=java-17-openjdk-headless
27-
ARG RUN_JAVA_VERSION=1.3.8
28-
ENV LANG='en_US.UTF-8' LANGUAGE='en_US:en'
29-
# Install java and the run-java script
30-
# Also set up permissions for user `1001`
31-
RUN microdnf install curl ca-certificates ${JAVA_PACKAGE} \
32-
&& microdnf update \
33-
&& microdnf clean all \
34-
&& mkdir /deployments \
35-
&& chown 1001 /deployments \
36-
&& chmod "g+rwX" /deployments \
37-
&& chown 1001:root /deployments \
38-
&& curl https://repo1.maven.org/maven2/io/fabric8/run-java-sh/${RUN_JAVA_VERSION}/run-java-sh-${RUN_JAVA_VERSION}-sh.sh -o /deployments/run-java.sh \
39-
&& chown 1001 /deployments/run-java.sh \
40-
&& chmod 540 /deployments/run-java.sh \
41-
&& echo "securerandom.source=file:/dev/urandom" >> /etc/alternatives/jre/lib/security/java.security
4284

43-
# Configure the JAVA_OPTIONS, you can add -XshowSettings:vm to also display the heap size.
44-
ENV JAVA_OPTIONS="-Dquarkus.http.host=0.0.0.0 -Djava.util.logging.manager=org.jboss.logmanager.LogManager"
4585
COPY target/lib/* /deployments/lib/
46-
COPY target/*-runner.jar /deployments/app.jar
86+
COPY target/*-runner.jar /deployments/quarkus-run.jar
4787

4888
EXPOSE 8080
49-
USER 1001
89+
USER 185
90+
ENV JAVA_OPTS_APPEND="-Dquarkus.http.host=0.0.0.0 -Djava.util.logging.manager=org.jboss.logmanager.LogManager"
91+
ENV JAVA_APP_JAR="/deployments/quarkus-run.jar"
5092

51-
ENTRYPOINT [ "/deployments/run-java.sh" ]
93+
ENTRYPOINT [ "/opt/jboss/container/java/run/run-java.sh" ]

‎getting-started/src/main/docker/Dockerfile.native‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
####
2-
# This Dockerfile is used in order to build a container that runs the Quarkus application in native (no JVM) mode
2+
# This Dockerfile is used in order to build a container that runs the Quarkus application in native (no JVM) mode.
33
#
44
# Before building the container image run:
55
#
6-
# ./mvnw package -Pnative
6+
# ./mvnw package -Dnative
77
#
88
# Then, build the image with:
99
#
@@ -14,7 +14,7 @@
1414
# docker run -i --rm -p 8080:8080 quarkus/getting-started
1515
#
1616
###
17-
FROM registry.access.redhat.com/ubi8/ubi-minimal:8.3
17+
FROM registry.access.redhat.com/ubi8/ubi-minimal:8.9
1818
WORKDIR /work/
1919
RUN chown 1001 /work \
2020
&& chmod "g+rwX" /work \
@@ -24,4 +24,4 @@ COPY --chown=1001:root target/*-runner /work/application
2424
EXPOSE 8080
2525
USER 1001
2626

27-
CMD ["./application", "-Dquarkus.http.host=0.0.0.0"]
27+
ENTRYPOINT ["./application", "-Dquarkus.http.host=0.0.0.0"]

‎getting-started/src/main/docker/Dockerfile.native-micro‎

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
####
2-
# This Dockerfile is used in order to build a distroless container that runs the Quarkus application in native (no JVM) mode
2+
# This Dockerfile is used in order to build a container that runs the Quarkus application in native (no JVM) mode.
3+
# It uses a micro base image, tuned for Quarkus native executables.
4+
# It reduces the size of the resulting container image.
5+
# Check https://quarkus.io/guides/quarkus-runtime-base-image for further information about this image.
36
#
47
# Before building the container image run:
58
#
6-
# ./mvnw package -Pnative
9+
# ./mvnw package -Dnative
710
#
811
# Then, build the image with:
912
#
@@ -14,10 +17,14 @@
1417
# docker run -i --rm -p 8080:8080 quarkus/getting-started
1518
#
1619
###
17-
FROM quay.io/quarkus/quarkus-micro-image:1.0
18-
COPY target/*-runner /application
20+
FROM quay.io/quarkus/quarkus-micro-image:2.0
21+
WORKDIR /work/
22+
RUN chown 1001 /work \
23+
&& chmod "g+rwX" /work \
24+
&& chown 1001:root /work
25+
COPY --chown=1001:root target/*-runner /work/application
1926

2027
EXPOSE 8080
2128
USER 1001
2229

23-
CMD ["./application", "-Dquarkus.http.host=0.0.0.0"]
30+
ENTRYPOINT ["./application", "-Dquarkus.http.host=0.0.0.0"]

0 commit comments

Comments
 (0)