mirror of
https://github.com/cloudnative-pg/plugin-barman-cloud.git
synced 2026-01-12 05:33:11 +01:00
docs: describe instanceSidecarConfiguration
Document how the instance sidecar is configured and what happens when resources definitions conflict between objectstores. Signed-off-by: Francesco Canovai <francesco.canovai@enterprisedb.com>
This commit is contained in:
parent
eae195b5d3
commit
fd6f3e9b10
@ -210,3 +210,37 @@ spec:
|
||||
parameters:
|
||||
barmanObjectName: minio-store-b
|
||||
```
|
||||
|
||||
## Configuring the plugin instance sidecar
|
||||
|
||||
The Barman Cloud Plugin uses a sidecar container that runs alongside each
|
||||
PostgreSQL instance pod. This sidecar handles backup, WAL archiving, and restore
|
||||
operations. You can control how the sidecar works by setting the
|
||||
`.spec.instanceSidecarConfiguration` section in your `ObjectStore` resource.
|
||||
These settings apply to all PostgreSQL instances that use this object store.
|
||||
|
||||
```yaml
|
||||
apiVersion: barmancloud.cnpg.io/v1
|
||||
kind: ObjectStore
|
||||
metadata:
|
||||
name: minio-store
|
||||
spec:
|
||||
configuration:
|
||||
# [...]
|
||||
instanceSidecarConfiguration:
|
||||
retentionPolicyIntervalSeconds: 30
|
||||
resources:
|
||||
requests:
|
||||
memory: "64Mi"
|
||||
cpu: "250m"
|
||||
limits:
|
||||
memory: "512Mi"
|
||||
cpu: "500m"
|
||||
```
|
||||
|
||||
When the plugin is enabled, the sidecar is automatically injected into each
|
||||
PostgreSQL instance pod. Even if you define multiple `ObjectStore` resources,
|
||||
only one sidecar will run per instance. If a replica cluster also archives WALs
|
||||
to a different `ObjectStore`, the sidecar will use the resource settings from the
|
||||
`ObjectStore` referenced by the archiving plugin, not the one in the
|
||||
`.spec.externalClusters` section.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user