Backup v1.3.0 custom resource definition

Select a documentation version:

Spec schema

BackupSpec defines the desired state of Backup.

  backupPlanRef 
 : 
  
 string 
 dbclusterRef 
 : 
  
 string 
 manual 
 : 
  
 physicalbackupSpec 
 : 
  
 backuptype 
 : 
  
 string 
  
 type 
 : 
  
 boolean 
 physicalbackupSpec 
 : 
  
 string 
 

Field

Type
Required or optional
Description
backupPlanRef
string
Required
Name of the BackupPlan from which this backup was created.
dbclusterRef
string
Required
The DBCluster name this backup belongs to.
manual
boolean
Optional
Indicates whether this backup is a scheduled or manual backup. Defaults to false (scheduled backup) if not specified.
manual.physicalbackupSpec
object
Optional
Contains spec for physical backups, allowing to specify backup type as an enum in {"full","diff","incr"}. Default to full if not specified.
manual.physicalbackupSpec.backuptype
string
Optional
The type of backup to be created. It's an enum in {"full","diff","incr"}. Default to full if not specified.

Status schema

BackupStatus defines the observed state of Backup.

  completeTime 
 : 
  
 string 
 conditions 
 : 
 - 
  
 lastTransitionTime 
 : 
  
 string 
  
 message 
 : 
  
 string 
  
 observedGeneration 
 : 
  
 integer 
  
 reason 
 : 
  
 string 
  
 status 
 : 
  
 string 
  
 type 
 : 
  
 string 
 createTime 
 : 
  
 string 
 criticalIncidents 
 : 
 - 
  
 code 
 : 
  
 string 
  
 createTime 
 : 
  
 string 
  
 message 
 : 
  
 string 
  
 messageTemplateParams 
 : 
  
 object 
  
 resource 
 : 
  
 component 
 : 
  
 string 
  
 location 
 : 
  
 cluster 
 : 
  
 string 
  
 group 
 : 
  
 string 
  
 kind 
 : 
  
 string 
  
 name 
 : 
  
 string 
  
 namespace 
 : 
  
 string 
  
 version 
 : 
  
 string 
  
 stackTrace 
 : 
  
 - 
  
 component 
 : 
  
 string 
  
 message 
 : 
  
 string 
  
 transientUntil 
 : 
  
 string 
 observedGeneration 
 : 
  
 integer 
 phase 
 : 
  
 string 
 physicalbackupStatus 
 : 
  
 backupID 
 : 
  
 string 
  
 priorBackup 
 : 
  
 string 
 reconciled 
 : 
  
 boolean 
 retainexpireTime 
 : 
  
 string 
 

Field

Type
Required or optional
Description
completeTime
string
Optional
Completion time of the Backup.
conditions[]
object
Optional
Represents the latest available observations of the entity's current state.
conditions[].lastTransitionTime
string
Required
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.
conditions[].message
string
Required
a human readable message indicating details about the transition. This may be an empty string.
conditions[].observedGeneration
integer
Optional
Represents the .metadata.generation that the condition was set based upon. For example, 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.
conditions[].reason
string
Required
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.
conditions[].status
string
Required
Status of the condition, one of True, False, Unknown.
conditions[].type
string
Required
Type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt).
createTime
string
Optional
Creation time of the Backup.
criticalIncidents[]
object
Required
CriticalIncidents is a flat list of all active Critical Incidents.
criticalIncidents[].code
string
Required
The error code of this particular error. Error codes are DBSE+numeric strings, like "DBSE1012".
criticalIncidents[].createTime
string
Required
The timestamp when this Incident was created at the origin.
criticalIncidents[].message
string
Optional
Message describes the incident/error that occurred.
criticalIncidents[].messageTemplateParams
object
Optional
Contains key-value pairs necessary for generating a user-friendly data-driven version of Message in the user interface.
criticalIncidents[].resource
object
Required
Contains information about the Database Service component that reported the incident as well as about the K8s resource.
criticalIncidents[].resource.component
string
Required
An internal identifier of the Database Service subsystem that reported the incident.
criticalIncidents[].resource.location
object
Optional
Location.
criticalIncidents[].resource.location.cluster
string
Optional
The name of the cluster of the affected Kubernetes resource.
criticalIncidents[].resource.location.group
string
Optional
The Group name of the Kubernetes resource.
criticalIncidents[].resource.location.kind
string
Optional
The Kind of the Kubernetes resource.
criticalIncidents[].resource.location.name
string
Optional
The name of the affected Kubernetes resource.
criticalIncidents[].resource.location.namespace
string
Optional
The namespace of the affected Kubernetes resource.
criticalIncidents[].resource.location.version
string
Optional
The Version of the Kubernetes resource.
criticalIncidents[].stackTrace
object
Optional
An unstructured list of messages from the stack trace.
criticalIncidents[].stackTrace.component
string
Optional
The name of a Database Service component that logged the message.
criticalIncidents[].stackTrace.message
string
Optional
Logged message.
criticalIncidents[].transientUntil
string
Optional
If present indicates that the issue should be considered transient until the specified time.
observedGeneration
integer
Optional
Internal: The generation observed by the controller.
phase
string
Optional
BackupPhase is the phase of a backup.
phase.physicalBackupStatus
object
Optional
PhysicalBackupStatus contains status info that are specific for physical backups.
phase.physicalBackupStatus.backupID
string
Optional
The unique id of the physical backup tracked by pgbackrest.
phase.physicalBackupStatus.priorBackup
string
Optional
PriorBackup is the prior backup this backup depends on.
reconciled
boolean
Optional
Internal: Whether the resource was reconciled by the controller.
retainExpireTime
string
Optional
RetainExpireTime defines the time when the Backup is deleted. It's an output only field calculated from create_time + retain_days, and is updated accordingly when the retain_days field of a Backup is updated.
Design a Mobile Site
View Site in Mobile | Classic
Share by: