From 5d45a7ceef57ee1717cf896d8bc5ecaa1e6d8426 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?N=C3=A1ndor=20Holozsny=C3=A1k?= Date: Thu, 27 Apr 2023 22:49:19 +0200 Subject: [PATCH] build(core): Docker image build on release (#14) - Docker image build on release --- .github/workflows/ci-build.yml | 2 - .github/workflows/release.yml | 6 ++ .github/workflows/snapshot-release.yml | 6 ++ README.adoc | 7 +- jbang-catalog-document-generator-cli/pom.xml | 15 +++ .../src/main/docker/Dockerfile.jvm | 95 ------------------- .../src/main/docker/Dockerfile.legacy-jar | 91 ------------------ .../src/main/docker/Dockerfile.native | 27 ------ .../src/main/docker/Dockerfile.native-micro | 30 ------ .../src/main/resources/application.properties | 6 +- 10 files changed, 38 insertions(+), 247 deletions(-) delete mode 100644 jbang-catalog-document-generator-cli/src/main/docker/Dockerfile.jvm delete mode 100644 jbang-catalog-document-generator-cli/src/main/docker/Dockerfile.legacy-jar delete mode 100644 jbang-catalog-document-generator-cli/src/main/docker/Dockerfile.native delete mode 100644 jbang-catalog-document-generator-cli/src/main/docker/Dockerfile.native-micro diff --git a/.github/workflows/ci-build.yml b/.github/workflows/ci-build.yml index 7440c0d..1dc7656 100644 --- a/.github/workflows/ci-build.yml +++ b/.github/workflows/ci-build.yml @@ -28,8 +28,6 @@ jobs: cache: maven - name: Build & Verify Project run: ./mvnw verify -# - name: Native build -# run: ./mvnw package -Pnative - name: Publish Test Report uses: mikepenz/action-junit-report@v3 if: always() # always run even if the previous step fails diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index c1b53b7..c381b55 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -39,6 +39,12 @@ jobs: github-token: ${{ secrets.GITHUB_TOKEN }} native-image-job-reports: 'true' cache: maven + - name: Login to GitHub Container Registry + uses: docker/login-action@v2 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.PAT }} - name: Stage Files for Release run: | ./mvnw versions:set -DnewVersion=$RELEASE_VERSION diff --git a/.github/workflows/snapshot-release.yml b/.github/workflows/snapshot-release.yml index 26ff1b8..6d00638 100644 --- a/.github/workflows/snapshot-release.yml +++ b/.github/workflows/snapshot-release.yml @@ -38,6 +38,12 @@ jobs: github-token: ${{ secrets.GITHUB_TOKEN }} native-image-job-reports: 'true' cache: maven + - name: Login to GitHub Container Registry + uses: docker/login-action@v2 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.PAT }} - name: Stage Files for Snapshot Release run: | ./mvnw versions:set -DnewVersion=999-SNAPSHOT diff --git a/README.adoc b/README.adoc index 4f9afa7..205a3ce 100644 --- a/README.adoc +++ b/README.adoc @@ -256,7 +256,12 @@ Coming soon. === Docker image -Coming soon. +The tool is available within a Docker image, check the https://github.com/rodnansol/jbang-catalog-document-generator/pkgs/container/jbang-catalog-document-generator[packages] of the organization. + +[source,bash] +---- +docker run -v $(pwd):/resources ghcr.io/rodnansol/jbang-catalog-document-generator: generate /resources/jbang-catalog.json -o /resources/jbang-catalog.adoc +---- == Output diff --git a/jbang-catalog-document-generator-cli/pom.xml b/jbang-catalog-document-generator-cli/pom.xml index 41466c8..f0b7e10 100644 --- a/jbang-catalog-document-generator-cli/pom.xml +++ b/jbang-catalog-document-generator-cli/pom.xml @@ -48,7 +48,21 @@ uber-jar + + release + + true + true + + + + io.quarkus + quarkus-container-image-jib + + + + @@ -68,4 +82,5 @@ + \ No newline at end of file diff --git a/jbang-catalog-document-generator-cli/src/main/docker/Dockerfile.jvm b/jbang-catalog-document-generator-cli/src/main/docker/Dockerfile.jvm deleted file mode 100644 index 9726b0d..0000000 --- a/jbang-catalog-document-generator-cli/src/main/docker/Dockerfile.jvm +++ /dev/null @@ -1,95 +0,0 @@ -#### -# This Dockerfile is used in order to build a container that runs the Quarkus application in JVM mode -# -# Before building the container image run: -# -# ./mvnw package -# -# Then, build the image with: -# -# docker build -f src/main/docker/Dockerfile.jvm -t quarkus/jbang-catalog-generator-jvm . -# -# Then run the container using: -# -# docker run -i --rm -p 8080:8080 quarkus/jbang-catalog-generator-jvm -# -# If you want to include the debug port into your docker image -# you will have to expose the debug port (default 5005 being the default) like this : EXPOSE 8080 5005. -# Additionally you will have to set -e JAVA_DEBUG=true and -e JAVA_DEBUG_PORT=*:5005 -# when running the container -# -# Then run the container using : -# -# docker run -i --rm -p 8080:8080 quarkus/jbang-catalog-generator-jvm -# -# This image uses the `run-java.sh` script to run the application. -# This scripts computes the command line to execute your Java application, and -# includes memory/GC tuning. -# You can configure the behavior using the following environment properties: -# - JAVA_OPTS: JVM options passed to the `java` command (example: "-verbose:class") -# - JAVA_OPTS_APPEND: User specified Java options to be appended to generated options -# in JAVA_OPTS (example: "-Dsome.property=foo") -# - JAVA_MAX_MEM_RATIO: Is used when no `-Xmx` option is given in JAVA_OPTS. This is -# used to calculate a default maximal heap memory based on a containers restriction. -# If used in a container without any memory constraints for the container then this -# option has no effect. If there is a memory constraint then `-Xmx` is set to a ratio -# of the container available memory as set here. The default is `50` which means 50% -# of the available memory is used as an upper boundary. You can skip this mechanism by -# setting this value to `0` in which case no `-Xmx` option is added. -# - JAVA_INITIAL_MEM_RATIO: Is used when no `-Xms` option is given in JAVA_OPTS. This -# is used to calculate a default initial heap memory based on the maximum heap memory. -# If used in a container without any memory constraints for the container then this -# option has no effect. If there is a memory constraint then `-Xms` is set to a ratio -# of the `-Xmx` memory as set here. The default is `25` which means 25% of the `-Xmx` -# is used as the initial heap size. You can skip this mechanism by setting this value -# to `0` in which case no `-Xms` option is added (example: "25") -# - JAVA_MAX_INITIAL_MEM: Is used when no `-Xms` option is given in JAVA_OPTS. -# This is used to calculate the maximum value of the initial heap memory. If used in -# a container without any memory constraints for the container then this option has -# no effect. If there is a memory constraint then `-Xms` is limited to the value set -# here. The default is 4096MB which means the calculated value of `-Xms` never will -# be greater than 4096MB. The value of this variable is expressed in MB (example: "4096") -# - JAVA_DIAGNOSTICS: Set this to get some diagnostics information to standard output -# when things are happening. This option, if set to true, will set -# `-XX:+UnlockDiagnosticVMOptions`. Disabled by default (example: "true"). -# - JAVA_DEBUG: If set remote debugging will be switched on. Disabled by default (example: -# true"). -# - JAVA_DEBUG_PORT: Port used for remote debugging. Defaults to 5005 (example: "8787"). -# - CONTAINER_CORE_LIMIT: A calculated core limit as described in -# https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt. (example: "2") -# - CONTAINER_MAX_MEMORY: Memory limit given to the container (example: "1024"). -# - GC_MIN_HEAP_FREE_RATIO: Minimum percentage of heap free after GC to avoid expansion. -# (example: "20") -# - GC_MAX_HEAP_FREE_RATIO: Maximum percentage of heap free after GC to avoid shrinking. -# (example: "40") -# - GC_TIME_RATIO: Specifies the ratio of the time spent outside the garbage collection. -# (example: "4") -# - GC_ADAPTIVE_SIZE_POLICY_WEIGHT: The weighting given to the current GC time versus -# previous GC times. (example: "90") -# - GC_METASPACE_SIZE: The initial metaspace size. (example: "20") -# - GC_MAX_METASPACE_SIZE: The maximum metaspace size. (example: "100") -# - GC_CONTAINER_OPTIONS: Specify Java GC to use. The value of this variable should -# contain the necessary JRE command-line options to specify the required GC, which -# will override the default of `-XX:+UseParallelGC` (example: -XX:+UseG1GC). -# - HTTPS_PROXY: The location of the https proxy. (example: "myuser@127.0.0.1:8080") -# - HTTP_PROXY: The location of the http proxy. (example: "myuser@127.0.0.1:8080") -# - NO_PROXY: A comma separated lists of hosts, IP addresses or domains that can be -# accessed directly. (example: "foo.example.com,bar.example.com") -# -### -FROM registry.access.redhat.com/ubi8/openjdk-17:1.14 - -ENV LANGUAGE='en_US:en' - - -# We make four distinct layers so if there are application changes the library layers can be re-used -COPY --chown=185 target/quarkus-app/lib/ /deployments/lib/ -COPY --chown=185 target/quarkus-app/*.jar /deployments/ -COPY --chown=185 target/quarkus-app/app/ /deployments/app/ -COPY --chown=185 target/quarkus-app/quarkus/ /deployments/quarkus/ - -EXPOSE 8080 -USER 185 -ENV JAVA_OPTS="-Dquarkus.http.host=0.0.0.0 -Djava.util.logging.manager=org.jboss.logmanager.LogManager" -ENV JAVA_APP_JAR="/deployments/quarkus-run.jar" - diff --git a/jbang-catalog-document-generator-cli/src/main/docker/Dockerfile.legacy-jar b/jbang-catalog-document-generator-cli/src/main/docker/Dockerfile.legacy-jar deleted file mode 100644 index 1843ba4..0000000 --- a/jbang-catalog-document-generator-cli/src/main/docker/Dockerfile.legacy-jar +++ /dev/null @@ -1,91 +0,0 @@ -#### -# This Dockerfile is used in order to build a container that runs the Quarkus application in JVM mode -# -# Before building the container image run: -# -# ./mvnw package -Dquarkus.package.type=legacy-jar -# -# Then, build the image with: -# -# docker build -f src/main/docker/Dockerfile.legacy-jar -t quarkus/jbang-catalog-generator-legacy-jar . -# -# Then run the container using: -# -# docker run -i --rm -p 8080:8080 quarkus/jbang-catalog-generator-legacy-jar -# -# If you want to include the debug port into your docker image -# you will have to expose the debug port (default 5005 being the default) like this : EXPOSE 8080 5005. -# Additionally you will have to set -e JAVA_DEBUG=true and -e JAVA_DEBUG_PORT=*:5005 -# when running the container -# -# Then run the container using : -# -# docker run -i --rm -p 8080:8080 quarkus/jbang-catalog-generator-legacy-jar -# -# This image uses the `run-java.sh` script to run the application. -# This scripts computes the command line to execute your Java application, and -# includes memory/GC tuning. -# You can configure the behavior using the following environment properties: -# - JAVA_OPTS: JVM options passed to the `java` command (example: "-verbose:class") -# - JAVA_OPTS_APPEND: User specified Java options to be appended to generated options -# in JAVA_OPTS (example: "-Dsome.property=foo") -# - JAVA_MAX_MEM_RATIO: Is used when no `-Xmx` option is given in JAVA_OPTS. This is -# used to calculate a default maximal heap memory based on a containers restriction. -# If used in a container without any memory constraints for the container then this -# option has no effect. If there is a memory constraint then `-Xmx` is set to a ratio -# of the container available memory as set here. The default is `50` which means 50% -# of the available memory is used as an upper boundary. You can skip this mechanism by -# setting this value to `0` in which case no `-Xmx` option is added. -# - JAVA_INITIAL_MEM_RATIO: Is used when no `-Xms` option is given in JAVA_OPTS. This -# is used to calculate a default initial heap memory based on the maximum heap memory. -# If used in a container without any memory constraints for the container then this -# option has no effect. If there is a memory constraint then `-Xms` is set to a ratio -# of the `-Xmx` memory as set here. The default is `25` which means 25% of the `-Xmx` -# is used as the initial heap size. You can skip this mechanism by setting this value -# to `0` in which case no `-Xms` option is added (example: "25") -# - JAVA_MAX_INITIAL_MEM: Is used when no `-Xms` option is given in JAVA_OPTS. -# This is used to calculate the maximum value of the initial heap memory. If used in -# a container without any memory constraints for the container then this option has -# no effect. If there is a memory constraint then `-Xms` is limited to the value set -# here. The default is 4096MB which means the calculated value of `-Xms` never will -# be greater than 4096MB. The value of this variable is expressed in MB (example: "4096") -# - JAVA_DIAGNOSTICS: Set this to get some diagnostics information to standard output -# when things are happening. This option, if set to true, will set -# `-XX:+UnlockDiagnosticVMOptions`. Disabled by default (example: "true"). -# - JAVA_DEBUG: If set remote debugging will be switched on. Disabled by default (example: -# true"). -# - JAVA_DEBUG_PORT: Port used for remote debugging. Defaults to 5005 (example: "8787"). -# - CONTAINER_CORE_LIMIT: A calculated core limit as described in -# https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt. (example: "2") -# - CONTAINER_MAX_MEMORY: Memory limit given to the container (example: "1024"). -# - GC_MIN_HEAP_FREE_RATIO: Minimum percentage of heap free after GC to avoid expansion. -# (example: "20") -# - GC_MAX_HEAP_FREE_RATIO: Maximum percentage of heap free after GC to avoid shrinking. -# (example: "40") -# - GC_TIME_RATIO: Specifies the ratio of the time spent outside the garbage collection. -# (example: "4") -# - GC_ADAPTIVE_SIZE_POLICY_WEIGHT: The weighting given to the current GC time versus -# previous GC times. (example: "90") -# - GC_METASPACE_SIZE: The initial metaspace size. (example: "20") -# - GC_MAX_METASPACE_SIZE: The maximum metaspace size. (example: "100") -# - GC_CONTAINER_OPTIONS: Specify Java GC to use. The value of this variable should -# contain the necessary JRE command-line options to specify the required GC, which -# will override the default of `-XX:+UseParallelGC` (example: -XX:+UseG1GC). -# - HTTPS_PROXY: The location of the https proxy. (example: "myuser@127.0.0.1:8080") -# - HTTP_PROXY: The location of the http proxy. (example: "myuser@127.0.0.1:8080") -# - NO_PROXY: A comma separated lists of hosts, IP addresses or domains that can be -# accessed directly. (example: "foo.example.com,bar.example.com") -# -### -FROM registry.access.redhat.com/ubi8/openjdk-17:1.14 - -ENV LANGUAGE='en_US:en' - - -COPY target/lib/* /deployments/lib/ -COPY target/*-runner.jar /deployments/quarkus-run.jar - -EXPOSE 8080 -USER 185 -ENV JAVA_OPTS="-Dquarkus.http.host=0.0.0.0 -Djava.util.logging.manager=org.jboss.logmanager.LogManager" -ENV JAVA_APP_JAR="/deployments/quarkus-run.jar" diff --git a/jbang-catalog-document-generator-cli/src/main/docker/Dockerfile.native b/jbang-catalog-document-generator-cli/src/main/docker/Dockerfile.native deleted file mode 100644 index 26aa330..0000000 --- a/jbang-catalog-document-generator-cli/src/main/docker/Dockerfile.native +++ /dev/null @@ -1,27 +0,0 @@ -#### -# This Dockerfile is used in order to build a container that runs the Quarkus application in native (no JVM) mode. -# -# Before building the container image run: -# -# ./mvnw package -Pnative -# -# Then, build the image with: -# -# docker build -f src/main/docker/Dockerfile.native -t quarkus/jbang-catalog-generator . -# -# Then run the container using: -# -# docker run -i --rm -p 8080:8080 quarkus/jbang-catalog-generator -# -### -FROM registry.access.redhat.com/ubi8/ubi-minimal:8.6 -WORKDIR /work/ -RUN chown 1001 /work \ - && chmod "g+rwX" /work \ - && chown 1001:root /work -COPY --chown=1001:root target/*-runner /work/application - -EXPOSE 8080 -USER 1001 - -CMD ["./application", "-Dquarkus.http.host=0.0.0.0"] diff --git a/jbang-catalog-document-generator-cli/src/main/docker/Dockerfile.native-micro b/jbang-catalog-document-generator-cli/src/main/docker/Dockerfile.native-micro deleted file mode 100644 index 238fbc5..0000000 --- a/jbang-catalog-document-generator-cli/src/main/docker/Dockerfile.native-micro +++ /dev/null @@ -1,30 +0,0 @@ -#### -# This Dockerfile is used in order to build a container that runs the Quarkus application in native (no JVM) mode. -# It uses a micro base image, tuned for Quarkus native executables. -# It reduces the size of the resulting container image. -# Check https://quarkus.io/guides/quarkus-runtime-base-image for further information about this image. -# -# Before building the container image run: -# -# ./mvnw package -Pnative -# -# Then, build the image with: -# -# docker build -f src/main/docker/Dockerfile.native-micro -t quarkus/jbang-catalog-generator . -# -# Then run the container using: -# -# docker run -i --rm -p 8080:8080 quarkus/jbang-catalog-generator -# -### -FROM quay.io/quarkus/quarkus-micro-image:2.0 -WORKDIR /work/ -RUN chown 1001 /work \ - && chmod "g+rwX" /work \ - && chown 1001:root /work -COPY --chown=1001:root target/*-runner /work/application - -EXPOSE 8080 -USER 1001 - -CMD ["./application", "-Dquarkus.http.host=0.0.0.0"] diff --git a/jbang-catalog-document-generator-cli/src/main/resources/application.properties b/jbang-catalog-document-generator-cli/src/main/resources/application.properties index 243d4af..547c26d 100644 --- a/jbang-catalog-document-generator-cli/src/main/resources/application.properties +++ b/jbang-catalog-document-generator-cli/src/main/resources/application.properties @@ -1 +1,5 @@ -quarkus.package.add-runner-suffix=false \ No newline at end of file +quarkus.package.add-runner-suffix=false +quarkus.jib.base-jvm-image=eclipse-temurin:17-alpine +quarkus.container-image.group=rodnansol +quarkus.container-image.name=jbang-catalog-document-generator +quarkus.container-image.registry=ghcr.io \ No newline at end of file