docs: workaround for S3 checksum validation errors with recent boto3 versions (#398)

Fixes #393

Signed-off-by: Daniel Chambre <[email protected]>
Signed-off-by: Marco Nenciarini <[email protected]>
Signed-off-by: Gabriele Bartolini <[email protected]>
Co-authored-by: Marco Nenciarini <[email protected]>
Co-authored-by: Gabriele Bartolini <[email protected]>

Author: 3 people

.wordlist.txt

@@ -49,6 +49,7 @@ Uncomment
 WAL
 WALBackupConfiguration
 WALs
+amz
 api
 apiVersion
 apiextensions
@@ -59,6 +60,7 @@ backend
 backends
 barmanObjectName
 barmancloud
+boto
 bzip
 cd
 cloudnative
@@ -113,6 +115,7 @@ secretKeyRef
 selfsigned
 serverName
 serviceaccount
+sha
 sig
 storageClass
 subcommand

web/docs/object_stores.md

@@ -141,6 +141,34 @@ spec:
   [...]
 ```
 
+Recent changes to the [boto3 implementation](https://github.com/boto/boto3/issues/4392)
+of [Amazon S3 Data Integrity Protections](https://docs.aws.amazon.com/sdkref/latest/guide/feature-dataintegrity.html)
+may lead to the `x-amz-content-sha256` error when using the Barman Cloud
+Plugin.
+
+If you encounter this issue (see [GitHub issue #393](https://github.com/cloudnative-pg/plugin-barman-cloud/issues/393)),
+you can apply the following workaround by setting specific environment
+variables in the `ObjectStore` resource:
+
+```yaml
+apiVersion: barmancloud.cnpg.io/v1
+kind: ObjectStore
+metadata:
+  name: linode-store
+spec:
+  instanceSidecarConfiguration:
+    env:
+      - name: AWS_REQUEST_CHECKSUM_CALCULATION
+        value: when_required
+      - name: AWS_RESPONSE_CHECKSUM_VALIDATION
+        value: when_required
+  [...]
+```
+
+These settings ensure that checksum calculations and validations are only
+applied when explicitly required, avoiding compatibility issues with certain
+S3-compatible storage providers.
+
 Example with DigitalOcean Spaces (SFO3, path-style):
 
 ```yaml