From 750fb63010971358d31724014f10569da8f4e73c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Miloslav=20Trma=C4=8D?= <mitr@redhat.com>
Date: Thu, 26 Sep 2024 20:48:35 +0200
Subject: [PATCH] Document that zstd:chunked is downgraded to zstd when
 encrypting
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Partially resolves https://github.com/containers/common/issues/2117 .

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
---
 docs/containers.conf.5.md          | 5 +++++
 pkg/config/containers.conf         | 4 ++++
 pkg/config/containers.conf-freebsd | 2 ++
 3 files changed, 11 insertions(+)

diff --git a/docs/containers.conf.5.md b/docs/containers.conf.5.md
index 9252336a8..bc545c816 100644
--- a/docs/containers.conf.5.md
+++ b/docs/containers.conf.5.md
@@ -486,6 +486,9 @@ Name of destination for accessing the Podman service. See SERVICE DESTINATION TA
 List of compression algorithms. If set makes sure that requested compression variant
 for each platform is added to the manifest list keeping original instance intact in
 the same manifest list on every `manifest push`. Supported values are (`gzip`, `zstd` and `zstd:chunked`).
+`zstd:chunked` is incompatible with encrypting images, and will be treated as `zstd` with a warning
+in that case.
+
 
 Note: This is different from `compression_format` which allows users to select a default
 compression format for `push` and `manifest push`, while `add_compression` is limited to
@@ -855,6 +858,8 @@ Specifies the compression format to use when pushing an image. Supported values
 are: `gzip`, `zstd` and `zstd:chunked`. This field is ignored when pushing
 images to the docker-daemon and docker-archive formats. It is also ignored
 when the manifest format is set to v2s2.
+`zstd:chunked` is incompatible with encrypting images, and will be treated as `zstd` with a warning
+in that case.
 
 **compression_level**="5"
 
diff --git a/pkg/config/containers.conf b/pkg/config/containers.conf
index c00efecbb..7f0954931 100644
--- a/pkg/config/containers.conf
+++ b/pkg/config/containers.conf
@@ -416,6 +416,8 @@ default_sysctls = [
 #List of compression algorithms. If set makes sure that requested compression variant
 #for each platform is added to the manifest list keeping original instance intact in
 #the same manifest list on every `manifest push`. Supported values are (`gzip`, `zstd` and `zstd:chunked`).
+#`zstd:chunked` is incompatible with encrypting images, and will be treated as `zstd` with a warning
+#in that case.
 #
 #add_compression = ["gzip", "zstd", "zstd:chunked"]
 
@@ -438,6 +440,8 @@ default_sysctls = [
 # This field is ignored when pushing images to the docker-daemon and
 # docker-archive formats. It is also ignored when the manifest format is set
 # to v2s2.
+# `zstd:chunked` is incompatible with encrypting images, and will be treated as `zstd` with a warning
+# in that case.
 #
 #compression_format = "gzip"
 
diff --git a/pkg/config/containers.conf-freebsd b/pkg/config/containers.conf-freebsd
index 21753f4f2..894153ed3 100644
--- a/pkg/config/containers.conf-freebsd
+++ b/pkg/config/containers.conf-freebsd
@@ -326,6 +326,8 @@ default_sysctls = [
 
 # The compression format to use when pushing an image.
 # Valid options are: `gzip`, `zstd` and `zstd:chunked`.
+# `zstd:chunked` is incompatible with encrypting images, and will be treated as `zstd` with a warning
+# in that case.
 #
 #compression_format = "gzip"