Skip to content

Commit f53defa

Browse files
actions-useractions-user
committed
Sync documentation of main branch
1 parent 1fcb99c commit f53defa

File tree

3 files changed

+148
-1
lines changed

3 files changed

+148
-1
lines changed

‎_generated-doc/main/config/quarkus-all-config.adoc‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9431,6 +9431,71 @@ endif::add-copy-button-to-env-var[]
94319431
|boolean
94329432
|`false`
94339433

9434+
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-compression-enabled]] [.property-path]##link:#quarkus-core_quarkus-native-compression-enabled[`quarkus.native.compression.enabled`]##
9435+
ifdef::add-copy-button-to-config-props[]
9436+
config_property_copy_button:+++quarkus.native.compression.enabled+++[]
9437+
endif::add-copy-button-to-config-props[]
9438+
9439+
9440+
[.description]
9441+
--
9442+
Whether compression should be enabled.
9443+
9444+
9445+
ifdef::add-copy-button-to-env-var[]
9446+
Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_COMPRESSION_ENABLED+++[]
9447+
endif::add-copy-button-to-env-var[]
9448+
ifndef::add-copy-button-to-env-var[]
9449+
Environment variable: `+++QUARKUS_NATIVE_COMPRESSION_ENABLED+++`
9450+
endif::add-copy-button-to-env-var[]
9451+
--
9452+
|boolean
9453+
|`true`
9454+
9455+
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-compression-container-build]] [.property-path]##link:#quarkus-core_quarkus-native-compression-container-build[`quarkus.native.compression.container-build`]##
9456+
ifdef::add-copy-button-to-config-props[]
9457+
config_property_copy_button:+++quarkus.native.compression.container-build+++[]
9458+
endif::add-copy-button-to-config-props[]
9459+
9460+
9461+
[.description]
9462+
--
9463+
Whether the compression should be executed within a container.
9464+
9465+
9466+
ifdef::add-copy-button-to-env-var[]
9467+
Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_COMPRESSION_CONTAINER_BUILD+++[]
9468+
endif::add-copy-button-to-env-var[]
9469+
ifndef::add-copy-button-to-env-var[]
9470+
Environment variable: `+++QUARKUS_NATIVE_COMPRESSION_CONTAINER_BUILD+++`
9471+
endif::add-copy-button-to-env-var[]
9472+
--
9473+
|boolean
9474+
|
9475+
9476+
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-compression-container-image]] [.property-path]##link:#quarkus-core_quarkus-native-compression-container-image[`quarkus.native.compression.container-image`]##
9477+
ifdef::add-copy-button-to-config-props[]
9478+
config_property_copy_button:+++quarkus.native.compression.container-image+++[]
9479+
endif::add-copy-button-to-config-props[]
9480+
9481+
9482+
[.description]
9483+
--
9484+
The image used for compression. Defaults to `quarkus.native.builder-image` if not set.
9485+
9486+
Setting this variable will automatically activate
9487+
9488+
9489+
ifdef::add-copy-button-to-env-var[]
9490+
Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_COMPRESSION_CONTAINER_IMAGE+++[]
9491+
endif::add-copy-button-to-env-var[]
9492+
ifndef::add-copy-button-to-env-var[]
9493+
Environment variable: `+++QUARKUS_NATIVE_COMPRESSION_CONTAINER_IMAGE+++`
9494+
endif::add-copy-button-to-env-var[]
9495+
--
9496+
|string
9497+
|
9498+
94349499
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-compression-level]] [.property-path]##link:#quarkus-core_quarkus-native-compression-level[`quarkus.native.compression.level`]##
94359500
ifdef::add-copy-button-to-config-props[]
94369501
config_property_copy_button:+++quarkus.native.compression.level+++[]

‎_generated-doc/main/config/quarkus-core_quarkus.native.adoc‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -873,6 +873,71 @@ endif::add-copy-button-to-env-var[]
873873
|boolean
874874
|`false`
875875

876+
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-compression-enabled]] [.property-path]##link:#quarkus-core_quarkus-native-compression-enabled[`quarkus.native.compression.enabled`]##
877+
ifdef::add-copy-button-to-config-props[]
878+
config_property_copy_button:+++quarkus.native.compression.enabled+++[]
879+
endif::add-copy-button-to-config-props[]
880+
881+
882+
[.description]
883+
--
884+
Whether compression should be enabled.
885+
886+
887+
ifdef::add-copy-button-to-env-var[]
888+
Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_COMPRESSION_ENABLED+++[]
889+
endif::add-copy-button-to-env-var[]
890+
ifndef::add-copy-button-to-env-var[]
891+
Environment variable: `+++QUARKUS_NATIVE_COMPRESSION_ENABLED+++`
892+
endif::add-copy-button-to-env-var[]
893+
--
894+
|boolean
895+
|`true`
896+
897+
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-compression-container-build]] [.property-path]##link:#quarkus-core_quarkus-native-compression-container-build[`quarkus.native.compression.container-build`]##
898+
ifdef::add-copy-button-to-config-props[]
899+
config_property_copy_button:+++quarkus.native.compression.container-build+++[]
900+
endif::add-copy-button-to-config-props[]
901+
902+
903+
[.description]
904+
--
905+
Whether the compression should be executed within a container.
906+
907+
908+
ifdef::add-copy-button-to-env-var[]
909+
Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_COMPRESSION_CONTAINER_BUILD+++[]
910+
endif::add-copy-button-to-env-var[]
911+
ifndef::add-copy-button-to-env-var[]
912+
Environment variable: `+++QUARKUS_NATIVE_COMPRESSION_CONTAINER_BUILD+++`
913+
endif::add-copy-button-to-env-var[]
914+
--
915+
|boolean
916+
|
917+
918+
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-compression-container-image]] [.property-path]##link:#quarkus-core_quarkus-native-compression-container-image[`quarkus.native.compression.container-image`]##
919+
ifdef::add-copy-button-to-config-props[]
920+
config_property_copy_button:+++quarkus.native.compression.container-image+++[]
921+
endif::add-copy-button-to-config-props[]
922+
923+
924+
[.description]
925+
--
926+
The image used for compression. Defaults to `quarkus.native.builder-image` if not set.
927+
928+
Setting this variable will automatically activate
929+
930+
931+
ifdef::add-copy-button-to-env-var[]
932+
Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_COMPRESSION_CONTAINER_IMAGE+++[]
933+
endif::add-copy-button-to-env-var[]
934+
ifndef::add-copy-button-to-env-var[]
935+
Environment variable: `+++QUARKUS_NATIVE_COMPRESSION_CONTAINER_IMAGE+++`
936+
endif::add-copy-button-to-env-var[]
937+
--
938+
|string
939+
|
940+
876941
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-compression-level]] [.property-path]##link:#quarkus-core_quarkus-native-compression-level[`quarkus.native.compression.level`]##
877942
ifdef::add-copy-button-to-config-props[]
878943
config_property_copy_button:+++quarkus.native.compression.level+++[]

‎_versions/main/guides/upx.adoc‎

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,30 @@ Note that UPX compression:
2525
The UPX compression requires:
2626

2727
* the `upx` command to be available in the system `PATH`;
28+
* an explicitly defined `quarkus.native.compression.container-image`;
2829
* or to have built the native executable using an in-container build.
2930

31+
If `quarkus.native.compression.container-image` is not set explicitly, it will implicitly default to `quarkus.native.builder-image`.
32+
3033
If you have the `upx` command available on your path, Quarkus uses it.
31-
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.
34+
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.
35+
36+
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).
3237

3338
If you are not in one of these cases, the compression fails.
3439

40+
Setting `quarkus.native.compression.container-image` results in the compression to run in a container.
41+
If you want to set the variable, but not run the compression in a container, set `quakrus.native.compression.container-build` explicitly to `false`.
42+
43+
[IMPORTANT]
44+
.`WORKDIR` for the image used for compression
45+
====
46+
The executable to compress is mounted in directory `/project`.
47+
Since the container runs `upx` in the current working directory, the `WORKDIR` of the image used for compression must be `/project`.
48+
====
49+
50+
Compression can be explicitly en-/disabled by setting `quarkus.native.compression.enabled`.
51+
3552
[IMPORTANT]
3653
.upx is cross-platform.
3754
====

0 commit comments

Comments
 (0)