Stanza
pgbackrest.dalibo.com / v1
apiVersion: pgbackrest.dalibo.com/v1
kind: Stanza
metadata:
name: example
apiVersion
string
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind
string
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata
object
spec object required
spec defines the desired state of Stanza
stanzaConfiguration object required
Define pgbackrest stanza
archive object
async
boolean
getQueueMax
string
pattern:
^[0-9]+ ?(B|KiB|MiB|GiB|TiB|PiB)$
pushQueueMax
string
pattern:
^(0B|[0-9]+(KiB|MiB|GiB|TiB)|([0-4])PiB)$azureRepositories []object
account
string required
Azure repository account.
minLength:
1
container
string required
Azure container used to store the repository.
minLength:
1
endpoint
string
Azure repository endpoint.
minLength:
1
keyType
string
Azure repository key type.
enum:
shared, sas, autominLength:
1
repoPath
string required
Path where backups and archives are stored.
minLength:
1retentionPolicy object
Define retention strategy for a repository.
archive
integer
Number of backups worth of continuous WAL to retain.
Can be used to aggressively expire WAL segments and save disk space.
However, doing so negates the ability to perform PITR from the backups
with expired WAL and is therefore not recommended.
format:
int32minimum:
1maximum:
9.999999e+06
archiveType
string
Backup type for WAL retention.
It is recommended that this setting not be changed from the default which
will only expire WAL in conjunction with expiring full backups.
Available options are `full` (default), `diff` or `incr`.
enum:
full, diff, incr
diff
integer
Number of differential backups to retain.
When a differential backup expires, all incremental backups associated
with the differential backup will also expire. When not defined all
differential backups will be kept until the full backups they depend on expire.
format:
int32minimum:
1maximum:
9.999999e+06
full
integer
Full backup retention count/time (in days)
When a full backup expires, all differential and incremental backups associated
with the full backup will also expire.
format:
int32minimum:
1maximum:
9.999999e+06
fullType
string
Retention type for full backups.
Determines whether the repo-retention-full setting represents a time period
(days) or count of full backups to keep.
Available options are `count` (default) and `time`.
enum:
count, time
history
integer
Days of backup history manifests to retain.
Set history to define the number of days of backup history manifests to
retain. Unexpired backups are always kept in the backup history. Specify
history=0 to retain the backup history only for unexpired backups. When
a full backup history manifest is expired, all differential and
incremental backup history manifests associated with the full backup also
expire.
format:
int32minimum:
0maximum:
9.999999e+06secretRef object
Reference to a Kubernetes Secret containing the Azure repository key.
keyReference object
The reference to the Azure key.
key
string required
The key to select
name
string required
Name of the referent.
uriStyle
string
Azure URI Style.
enum:
host, path
verifyTLS
boolean
Repository storage certificate verify.
compressConfig object
Define compression settings for file compression.
level
integer
File compression level.
type
string
Type of compression to use.
enum:
bz2, gz, lz4, zst
customEnvVar
object
Custom environnement variables to use when running pgbackrest.
delta
boolean
Restore or backup using checksums.
During a restore, by default the PostgreSQL data and tablespace directories
are expected to be present but empty. This option performs a delta restore
using checksums.
During a backup, this option will use checksums instead of the timestamps to
determine if files will be copied.
logLevel
string
Level for console logging.
enum:
error, warn, info, detail, debug, trace
name
string required
minLength:
1
processMax
integer
s3Repositories []object
bucket
string required
S3 bucket used to store the repository.
minLength:
1cipherConfig object
encryptionPass object
Reference to the secret containing the encryption key.
key
string required
The key to select
name
string required
Name of the referent.
type
string
Cipher used to encrypt the repository.
enum:
aes-256-cbc
endpoint
string required
S3 repository endpoint.
minLength:
1
region
string required
S3 repository region.
minLength:
1
repoPath
string required
Path where backups and archive are stored.
minLength:
1retentionPolicy object
Define retention strategy for a repository.
archive
integer
Number of backups worth of continuous WAL to retain.
Can be used to aggressively expire WAL segments and save disk space.
However, doing so negates the ability to perform PITR from the backups
with expired WAL and is therefore not recommended.
format:
int32minimum:
1maximum:
9.999999e+06
archiveType
string
Backup type for WAL retention.
It is recommended that this setting not be changed from the default which
will only expire WAL in conjunction with expiring full backups.
Available options are `full` (default), `diff` or `incr`.
enum:
full, diff, incr
diff
integer
Number of differential backups to retain.
When a differential backup expires, all incremental backups associated
with the differential backup will also expire. When not defined all
differential backups will be kept until the full backups they depend on expire.
format:
int32minimum:
1maximum:
9.999999e+06
full
integer
Full backup retention count/time (in days)
When a full backup expires, all differential and incremental backups associated
with the full backup will also expire.
format:
int32minimum:
1maximum:
9.999999e+06
fullType
string
Retention type for full backups.
Determines whether the repo-retention-full setting represents a time period
(days) or count of full backups to keep.
Available options are `count` (default) and `time`.
enum:
count, time
history
integer
Days of backup history manifests to retain.
Set history to define the number of days of backup history manifests to
retain. Unexpired backups are always kept in the backup history. Specify
history=0 to retain the backup history only for unexpired backups. When
a full backup history manifest is expired, all differential and
incremental backup history manifests associated with the full backup also
expire.
format:
int32minimum:
0maximum:
9.999999e+06secretRef object
Reference to a Kubernetes Secret containing S3 credentials.
accessKeyId object
The reference to the access key ID
key
string required
The key to select
name
string required
Name of the referent.
secretAccessKey object
The reference to the secret access key
key
string required
The key to select
name
string required
Name of the referent.
uriStyle
string
S3 URI Style.
enum:
host, path
verifyTLS
boolean
Repository storage certificate verify.
startFast
boolean
Default behavior to Force a checkpoint to start backup quickly.
Forces a checkpoint (by passing y to the fast parameter of the backup start
function) so the backup begins immediately. Otherwise the backup will start
after the next regular checkpoint.
status object
status defines the observed state of Stanza
backupsCount object
Diff
integer required
Full
integer required
Incr
integer required
conditions []object
conditions represent the current state of the Stanza resource.
Each condition has a unique type and reflects the status of a specific aspect of the resource.
Standard condition types include:
- "Available": the resource is fully functional
- "Progressing": the resource is being created or updated
- "Degraded": the resource failed to reach or maintain its desired state
The status of each condition is one of True, False, or Unknown.
lastTransitionTime
string required
lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
format:
date-time
message
string required
message is a human readable message indicating details about the transition.
This may be an empty string.
maxLength:
32768
observedGeneration
integer
observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
format:
int64minimum:
0
reason
string required
reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
pattern:
^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$minLength:
1maxLength:
1024
status
string required
status of the condition, one of True, False, Unknown.
enum:
True, False, Unknown
type
string required
type of condition in CamelCase or in foo.example.com/CamelCase.
pattern:
^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$maxLength:
316recoveryWindow object
firstBackup object required
archive object required
start
string required
stop
string required
label
string required
lsn object required
start
string required
stop
string required
prior
string required
timestamp object required
start
integer required
format:
int64
stop
integer required
format:
int64
type
string required
lastBackup object required
archive object required
start
string required
stop
string required
label
string required
lsn object required
start
string required
stop
string required
prior
string required
timestamp object required
start
integer required
format:
int64
stop
integer required
format:
int64
type
string required
No matches. Try .spec.stanzaConfiguration for an exact path