plugin-barman-cloud/web/docs/plugin-barman-cloud.v1.md

API Reference

Packages

• barmancloud.cnpg.io/v1

barmancloud.cnpg.io/v1

Package v1 contains API Schema definitions for the barmancloud v1 API group

Resource Types

• ObjectStore

InstanceSidecarConfiguration

InstanceSidecarConfiguration defines the configuration for the sidecar that runs in the instance pods.

Appears in:

• ObjectStoreSpec

Field	Description	Required	Default	Validation
env EnvVar array	The environment to be explicitly passed to the sidecar
retentionPolicyIntervalSeconds integer	The retentionCheckInterval defines the frequency at which the system checks and enforces retention policies.		1800
resources ResourceRequirements	Resources define cpu/memory requests and limits for the sidecar that runs in the instance pods.
additionalContainerArgs string array	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"]

ObjectStore

ObjectStore is the Schema for the objectstores API.

Field	Description	Required	Default	Validation
apiVersion string	barmancloud.cnpg.io/v1	True
kind string	ObjectStore	True
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.	True
spec ObjectStoreSpec	Specification of the desired behavior of the ObjectStore. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status	True
status ObjectStoreStatus	Most recently observed status of the ObjectStore. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

ObjectStoreSpec

ObjectStoreSpec defines the desired state of ObjectStore.

Appears in:

• ObjectStore

Field	Description	Required	Default	Validation
configuration BarmanObjectStoreConfiguration	The configuration for the barman-cloud tool suite	True
retentionPolicy string	RetentionPolicy is the retention policy to be used for backups and WALs (i.e. '60d'). The retention policy is expressed in the form of XXu where XX is a positive integer and u is in [dwm] - days, weeks, months.			Pattern: ^[1-9][0-9]*[dwm]$
instanceSidecarConfiguration InstanceSidecarConfiguration	The configuration for the sidecar that runs in the instance pods

ObjectStoreStatus

ObjectStoreStatus defines the observed state of ObjectStore.

Appears in:

• ObjectStore

Field	Description	Required	Default	Validation
serverRecoveryWindow object (keys:string, values:RecoveryWindow)	ServerRecoveryWindow maps each server to its recovery window	True

RecoveryWindow

RecoveryWindow represents the time span between the first recoverability point and the last successful backup of a PostgreSQL server, defining the period during which data can be restored.

Appears in:

• ObjectStoreStatus

Field	Description	Required	Default	Validation
firstRecoverabilityPoint Time	The first recoverability point in a PostgreSQL server refers to the earliest point in time to which the database can be restored.	True
lastSuccessfulBackupTime Time	The last successful backup time	True
lastFailedBackupTime Time	The last failed backup time	True