summaryrefslogtreecommitdiffstats
path: root/doc/build-helpers
diff options
context:
space:
mode:
authorJoel Höner <athre0z@zyantific.com>2024-02-17 17:48:57 +0100
committerJoel Höner <athre0z@zyantific.com>2024-02-17 18:52:42 +0100
commit4b603ad9cd26f71bd17d52c2f6923ce6ba163c63 (patch)
tree0126a47239e6db80ad26ad7a14dcc40a3e80708c /doc/build-helpers
parentaf435645aed2bd50acad1f0866f3a6285de25e99 (diff)
dockerTools: configurable compression schema
This commit adds support for swapping out the compression algorithm used in all major docker-tools commands that generate images. The default algorithm remains unchanged (gzip).
Diffstat (limited to 'doc/build-helpers')
-rw-r--r--doc/build-helpers/images/dockertools.section.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/build-helpers/images/dockertools.section.md b/doc/build-helpers/images/dockertools.section.md
index 9317146b8f94..831a42f25423 100644
--- a/doc/build-helpers/images/dockertools.section.md
+++ b/doc/build-helpers/images/dockertools.section.md
@@ -178,6 +178,13 @@ Similarly, if you encounter errors similar to `Error_Protocol ("certificate has
_Default value:_ 0.
+`compressor` (String; _optional_)
+
+: Selects the algorithm used to compress the image.
+
+ _Default value:_ `"gz"`.\
+ _Possible values:_ `"none"`, `"gz"`, `"zstd"`.
+
`contents` **DEPRECATED**
: This attribute is deprecated, and users are encouraged to use `copyToRoot` instead.