Backup Custom Resource Definition

Preview

This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms. Pre-GA features are available "as is" and might have limited support. For more information, see the launch stage descriptions.

For information about access to this release, see the access request page.

Spec schema

Backup Spec defines the selected state of Backup.

Backup:
  metadata:
    name: string
  spec:
    backupPlanRef: string
    dbclusterRef: string

Field Type Required or optional	Description
name
string Required	Name of the Backup resource.
backupPlanRef
string Required	Name of the BackupPlan from which this backup was created.
dbclusterRef
string Required	The DBCluster name this backup belongs to.

Status schema

Backup Status 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
list (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, which is when the underlying condition changed. If that is not known, then use the time when the API field changed.
conditions[].message
string Required	A human readable message indicating details about the transition. This might be an empty string.
conditions[].observedGeneration
integer Optional	Represents the .metadata.generation that the condition was set upon. For example, if .metadata.generation is 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. The value should be a CamelCase string. This field cannot 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 regular expression it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt).
createTime
string Optional	Creation time of the Backup.
criticalIncidents
list (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 formatted as DBSE followed by a number, like DBSE1012.
criticalIncidents[].createTime
string Required	The timestamp when this Incident was created at the origin.
criticalIncidents[].message
string Optional	Message describes the incident or 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 cluster manager 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 cluster manager resource.
criticalIncidents[].resource.location.group
string Optional	The Group name of the cluster manager resource.
criticalIncidents[].resource.location.kind
string Optional	The Kind of the cluster manager resource.
criticalIncidents[].resource.location.name
string Optional	The name of the affected cluster manager resource.
criticalIncidents[].resource.location.namespace
string Optional	The namespace of the affected cluster manager resource.
criticalIncidents[].resource.location.version
string Optional	The Version of the cluster manager resource.
criticalIncidents[].stackTrace
list (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, this indicates that the issue is 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.
status.physicalBackupStatus.backupType
string Optional	BackupType indicates the type of the backup performed. It can be "full", "diff" (differential), or "incr" (incremental).
phase.physicalBackupStatus.priorBackup
string Optional	PriorBackup is the prior backup that this backup depends on.
reconciled
boolean Optional	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.
physicalbackupStatus.startTime
string Optional	The start time of the physical backup.
physicalbackupStatus.endTime
string Optional	The end time of the physical backup.
physicalbackupStatus.wal
object Optional	Contains the WAL (Write-Ahead Logging) segments.
physicalbackupStatus.wal.start
string Optional	The starting WAL segment.
physicalbackupStatus.wal.end
string Optional	The ending WAL segment.
physicalbackupStatus.lsn
object Optional	Contains the LSN (Log Sequence Number) range.
physicalbackupStatus.lsn.start
string Optional	The starting LSN.
physicalbackupStatus.lsn.stop
string Optional	The ending LSN.
physicalbackupStatus.size
object Optional	Contains various size metrics.
physicalbackupStatus.size.databaseSize
string Optional	The total size of the database.
physicalbackupStatus.size.databaseBackupSize
string Optional	The size of the database backup.
physicalbackupStatus.size.backupSetSize
string Optional	The size of the backup set.
physicalbackupStatus.size.backupSize
string Optional	The size of the backup.
physicalbackupStatus.compressed
boolean Optional	Indicates if compression is used.
physicalbackupStatus.encrypted
boolean Optional	Indicates if encryption is used.