From e3db82cde1f73b78193948accc25fb97154e8af8 Mon Sep 17 00:00:00 2001
From: Gabriele Bartolini <gabriele.bartolini@enterprisedb.com>
Date: Wed, 17 Sep 2025 17:07:21 +0200
Subject: [PATCH] chore: improve docs

Signed-off-by: Gabriele Bartolini <gabriele.bartolini@enterprisedb.com>
---
 api/v1/objectstore_types.go                            | 6 +++++-
 config/crd/bases/barmancloud.cnpg.io_objectstores.yaml | 8 ++++++--
 web/docs/plugin-barman-cloud.v1.md                     | 2 +-
 3 files changed, 12 insertions(+), 4 deletions(-)

diff --git a/api/v1/objectstore_types.go b/api/v1/objectstore_types.go
index b8458d6..be3939e 100644
--- a/api/v1/objectstore_types.go
+++ b/api/v1/objectstore_types.go
@@ -38,7 +38,11 @@ type InstanceSidecarConfiguration struct {
 	// +optional
 	Resources corev1.ResourceRequirements `json:"resources,omitempty"`
 
-	// AdditionalContainerArgs defines additional arguments to be passed to the sidecar container
+	// AdditionalContainerArgs is an optional list of command-line arguments
+	// to be passed to the sidecar container when it starts.
+	// The provided arguments are appended to the container’s default
+	// arguments. This can be used, for example, to enable verbose logging.
+	// Example: ["--log-level=debug"]
 	// +optional
 	AdditionalContainerArgs []string `json:"additionalContainerArgs,omitempty"`
 }
diff --git a/config/crd/bases/barmancloud.cnpg.io_objectstores.yaml b/config/crd/bases/barmancloud.cnpg.io_objectstores.yaml
index a2bc72e..4ba8c22 100644
--- a/config/crd/bases/barmancloud.cnpg.io_objectstores.yaml
+++ b/config/crd/bases/barmancloud.cnpg.io_objectstores.yaml
@@ -392,8 +392,12 @@ spec:
                   pods
                 properties:
                   additionalContainerArgs:
-                    description: AdditionalContainerArgs defines additional arguments
-                      to be passed to the sidecar container
+                    description: |-
+                      AdditionalContainerArgs is an optional list of command-line arguments
+                      to be passed to the sidecar container when it starts.
+                      The provided arguments are appended to the container’s default
+                      arguments. This can be used, for example, to enable verbose logging.
+                      Example: ["--log-level=debug"]
                     items:
                       type: string
                     type: array
diff --git a/web/docs/plugin-barman-cloud.v1.md b/web/docs/plugin-barman-cloud.v1.md
index 64abe2d..906d578 100644
--- a/web/docs/plugin-barman-cloud.v1.md
+++ b/web/docs/plugin-barman-cloud.v1.md
@@ -29,7 +29,7 @@ _Appears in:_
 | `env` _[EnvVar](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#envvar-v1-core) array_ | The environment to be explicitly passed to the sidecar |  |  |  |
 | `retentionPolicyIntervalSeconds` _integer_ | The retentionCheckInterval defines the frequency at which the<br />system checks and enforces retention policies. |  | 1800 |  |
 | `resources` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#resourcerequirements-v1-core)_ | Resources define cpu/memory requests and limits for the sidecar that runs in the instance pods. |  |  |  |
-| `additionalContainerArgs` _string array_ | AdditionalContainerArgs defines additional arguments to be passed to the sidecar container |  |  |  |
+| `additionalContainerArgs` _string array_ | AdditionalContainerArgs is an optional list of command-line arguments<br />to be passed to the sidecar container when it starts.<br />The provided arguments are appended to the container’s default<br />arguments. This can be used, for example, to enable verbose logging.<br />Example: ["--log-level=debug"] |  |  |  |
 
 
 #### ObjectStore