Reference

Backup

API versionkobblestone.io/v1alpha1
KindBackup
ScopeNamespaced
kubectlkubectl get backups

A Backup defines a request for a snapshot of a Server.

The snapshot includes the servers data and configs. Transient data like .jar files is excluded.

Backups can be restored via the Restore object.

Live backups on running servers are supported and implemented using RCON.

Note: Backups are not supported for servers that do not have storage configured.

spec

jobobject

Configures the spec of the managed Job object.

4 fields

Maximum duration of the backup Job in seconds. When it is exceeded, the Job and thus the Backup fails.

Default is no limit.

Documentation
imagestring

Custom image for online backups of running servers.

Default is itzg/mc-backup.

Documentation
resourcesobject

Compute resources of the backup Pod.

Documentation
3 fields
claims[]object
2 fields
namestring
requeststring
limitsmap[string]string
requestsmap[string]string
tolerations[]object

Tolerations of the backup Pod.

Documentation
5 fields
effectstring
keystring
operatorstring
valuestring
repoRefobjectrequired

Reference to the BackupRepo that will store the Backup.

1 field
namestring

Policy that determines what should happen with the physical snapshot data when the Backup is deleted.

Values:

  • Retain: Snapshots are retained in their BackupRepo.
  • Delete: An attempt is made to delete the snapshot from the BackupRepo. The result of that deletion is ignored and not awaited.
  • RequireDelete: The snapshot must be deleted from the BackupRepo for the Backup to be finally removed. Deletion is retried until success.

Default is Retain.

  • One of: Retain, Delete, RequireDelete
targetRefobjectrequired

Reference to the target Server.

3 fields
apiGroupstring
kindstring
namestring

status

conditions[]object

Conditions of the Backup.

6 fields
  • Format: date-time
messagestring
reasonstring
statusstring
typestring
messagestring

Message explaining the current state of the Backup.

phasestring

Current phase of the Backup.

Values:

  • Pending: Backup is pending.
  • Running: Backup is currently running.
  • Completed: Backup completed successfully.
  • Failed: Backup failed.
  • One of: Pending, Running, Completed, Failed
repostring

Name of the target BackupRepo.

startedAtstring

Time at which the Job of the Backup was created.

  • Format: date-time
targetstring

Name of the target.