chore: improve docs

Signed-off-by: Gabriele Bartolini <gabriele.bartolini@enterprisedb.com>
This commit is contained in:
Gabriele Bartolini 2025-09-17 17:07:21 +02:00
parent 34ad37b615
commit e3db82cde1
3 changed files with 12 additions and 4 deletions

View File

@ -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 containers default
// arguments. This can be used, for example, to enable verbose logging.
// Example: ["--log-level=debug"]
// +optional
AdditionalContainerArgs []string `json:"additionalContainerArgs,omitempty"`
}

View File

@ -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 containers default
arguments. This can be used, for example, to enable verbose logging.
Example: ["--log-level=debug"]
items:
type: string
type: array

View File

@ -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 containers default<br />arguments. This can be used, for example, to enable verbose logging.<br />Example: ["--log-level=debug"] | | | |
#### ObjectStore