Merge pull request #48413 from turing85/main

Author: cescoffier

core/deployment/src/main/java/io/quarkus/deployment/pkg/NativeConfig.java

@@ -538,6 +538,25 @@ interface Debug {
 
     @ConfigGroup
     interface Compression {
+        /**
+         * Whether compression should be enabled.
+         */
+        @WithDefault("true")
+        boolean enabled();
+
+        /**
+         * Whether the compression should be executed within a container.
+         */
+        Optional<Boolean> containerBuild();
+
+        /**
+         * The image used for compression. Defaults to {@code quarkus.native.builder-image} if not
+         * set.
+         * <p>
+         * Setting this variable will automatically activate
+         */
+        Optional<String> containerImage();
+
         /**
          * The compression level in [1, 10].
          * 10 means <em>best</em>.

core/deployment/src/main/java/io/quarkus/deployment/pkg/steps/UpxCompressionBuildStep.java

@@ -41,7 +41,7 @@ public void compress(NativeConfig nativeConfig, NativeImageRunnerBuildItem nativ
             BuildProducer<UpxCompressedBuildItem> upxCompressedProducer,
             BuildProducer<ArtifactResultBuildItem> artifactResultProducer) {
 
-        if (nativeConfig.compression().level().isEmpty()) {
+        if (nativeConfig.compression().level().isEmpty() || !nativeConfig.compression().enabled()) {
             log.debug("UPX compression disabled");
             return;
         }
@@ -52,7 +52,8 @@ public void compress(NativeConfig nativeConfig, NativeImageRunnerBuildItem nativ
 
         String effectiveBuilderImage = nativeConfig.builderImage().getEffectiveImage();
         Optional<File> upxPathFromSystem = getUpxFromSystem();
-        if (upxPathFromSystem.isPresent()) {
+        if (upxPathFromSystem.isPresent() && !nativeConfig.compression().containerBuild().orElse(false)
+                && nativeConfig.compression().containerImage().isEmpty()) {
             log.debug("Running UPX from system path");
             if (!runUpxFromHost(upxPathFromSystem.get(), image.getPath().toFile(), nativeConfig)) {
                 throw new IllegalStateException("Unable to compress the native executable");
@@ -61,9 +62,12 @@ public void compress(NativeConfig nativeConfig, NativeImageRunnerBuildItem nativ
             log.error("Compression of native executables is not yet implemented for remote container builds.");
             throw new IllegalStateException(
                     "Unable to compress the native executable: Compression of native executables is not yet supported for remote container builds");
-        } else if (nativeImageRunner.isContainerBuild()) {
-            log.info("Running UPX from a container using the builder image: " + effectiveBuilderImage);
-            if (!runUpxInContainer(image, nativeConfig, effectiveBuilderImage)) {
+        } else if (nativeConfig.compression().containerBuild().orElse(true) &&
+                (nativeImageRunner.isContainerBuild() ||
+                        nativeConfig.compression().containerImage().isPresent())) {
+            String compressorImage = nativeConfig.compression().containerImage().orElse(effectiveBuilderImage);
+            log.info("Running UPX from a container using the compressor image: " + compressorImage);
+            if (!runUpxInContainer(image, nativeConfig, compressorImage)) {
                 throw new IllegalStateException("Unable to compress the native executable");
             }
         } else {

docs/src/main/asciidoc/upx.adoc

@@ -25,13 +25,30 @@ Note that UPX compression:
 The UPX compression requires:
 
 * the `upx` command to be available in the system `PATH`;
+* an explicitly defined `quarkus.native.compression.container-image`;
 * or to have built the native executable using an in-container build.
 
+If `quarkus.native.compression.container-image` is not set explicitly, it will implicitly default to `quarkus.native.builder-image`.
+
 If you have the `upx` command available on your path, Quarkus uses it.
-Otherwise, if you built the native image using an in-container build (using `quarkus.native.container-build=true`) and if the builder image provides the `upx` command, Quarkus compresses the executable from inside the container.
+Otherwise, if you built the native image using an in-container build (using `quarkus.native.container-build=true`) and if the compression image provides the `upx` command, Quarkus compresses the executable from inside the container.
+
+If you want to force compression to take place in a container, you can set `quarkus.native.compression.container-build` to `true` (or `false` to explicitly not run compression in a container).
 
 If you are not in one of these cases, the compression fails.
 
+Setting `quarkus.native.compression.container-image` results in the compression to run in a container.
+If you want to set the variable, but not run the compression in a container, set `quakrus.native.compression.container-build` explicitly to `false`.
+
+[IMPORTANT]
+.`WORKDIR` for the image used for compression
+====
+The executable to compress is mounted in directory `/project`.
+Since the container runs `upx` in the current working directory, the `WORKDIR` of the image used for compression must be `/project`.
+====
+
+Compression can be explicitly en-/disabled by setting `quarkus.native.compression.enabled`.
+
 [IMPORTANT]
 .upx is cross-platform.
 ====