chore: improve docs

Signed-off-by: Gabriele Bartolini <[email protected]>

Author: gbartolini

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"`
 }

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

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