marco/plugin-barman-cloud
1
0
Fork 0
mirror of https://github.com/cloudnative-pg/plugin-barman-cloud.git synced 2026-01-11 21:23:12 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity
74bdb9a590
plugin-barman-cloud/docs/src/plugin-barman-cloud.v1.md
Niccolò Fei 74bdb9a590
feat: generate apidoc using genref (#228) 
Closes #206

Signed-off-by: Niccolò Fei <niccolo.fei@enterprisedb.com>
Signed-off-by: Francesco Canovai <francesco.canovai@enterprisedb.com>
Co-authored-by: Francesco Canovai <francesco.canovai@enterprisedb.com>
2025-03-27 22:42:46 +01:00

5.3 KiB
Raw Blame History

API Reference

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

Resource Types

ObjectStore

ObjectStore is the Schema for the objectstores API.

FieldDescription
apiVersion [Required]
string		barmancloud.cnpg.io/v1
kind [Required]
string		ObjectStore
metadata [Required]
meta/v1.ObjectMeta 		No description provided.Refer to the Kubernetes API documentation for the fields of the metadata field.
spec [Required]
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
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

InstanceSidecarConfiguration

Appears in:

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

FieldDescription
env
[]core/v1.EnvVar

The environment to be explicitly passed to the sidecar
retentionPolicyIntervalSeconds
int

The retentionCheckInterval defines the frequency at which the system checks and enforces retention policies.

ObjectStoreSpec

Appears in:

ObjectStoreSpec defines the desired state of ObjectStore.

FieldDescription
configuration [Required]
github.com/cloudnative-pg/barman-cloud/pkg/api.BarmanObjectStoreConfiguration

The configuration for the barman-cloud tool suite
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.
instanceSidecarConfiguration
InstanceSidecarConfiguration

The configuration for the sidecar that runs in the instance pods

ObjectStoreStatus

Appears in:

ObjectStoreStatus defines the observed state of ObjectStore.

FieldDescription
serverRecoveryWindow [Required]
map[string]RecoveryWindow

ServerRecoveryWindow maps each server to its recovery window

RecoveryWindow

Appears in:

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.

FieldDescription
firstRecoverabilityPoint [Required]
meta/v1.Time

The first recoverability point in a PostgreSQL server refers to the earliest point in time to which the database can be restored.
lastSuccussfulBackupTime [Required]
meta/v1.Time

The last successful backup time