VirtualMachineBackup
backup.kubevirt.io / v1alpha1
apiVersion: backup.kubevirt.io/v1alpha1
kind: VirtualMachineBackup
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
VirtualMachineBackupSpec is the spec for a VirtualMachineBackup resource
forceFullBackup
boolean
ForceFullBackup indicates that a full backup is desired
mode
string
Mode specifies the way the backup output will be recieved
enum:
Push, Pull
pvcName
string
PvcName required in push mode. Specifies the name of the PVC
where the backup output will be stored
skipQuiesce
boolean
SkipQuiesce indicates whether the VM's filesystem shoule not be quiesced before the backup
source object required
Source specifies the backup source - either a VirtualMachine or a VirtualMachineBackupTracker.
When Kind is VirtualMachine: performs a backup of the specified VM.
When Kind is VirtualMachineBackupTracker: uses the tracker to get the source VM
and the base checkpoint for incremental backup. The tracker will be updated
with the new checkpoint after backup completion.
apiGroup
string
APIGroup is the group for the resource being referenced.
If APIGroup is not specified, the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required.
kind
string required
Kind is the type of resource being referenced
name
string required
Name is the name of resource being referenced
tokenSecretRef
string
TokenSecretRef is the name of the secret that
will be used to pull the backup from an associated endpoint
ttlDuration
string
TtlDuration limits the lifetime of a pull mode backup and its export
If this field is set, after this duration has passed from counting from CreationTimestamp,
the backup is eligible to be automatically considered as complete.
If this field is omitted, a reasonable default is applied.
status object
VirtualMachineBackupStatus is the status for a VirtualMachineBackup resource
checkpointName
string
CheckpointName the name of the checkpoint created for the current backup
conditions []object
lastProbeTime
string
format:
date-time
lastTransitionTime
string
format:
date-time
message
string
reason
string
status
string required
type
string required
ConditionType is the const type for Conditions
endpointCert
string
EndpointCert is the raw CACert that is to be used when connecting
to an exported backup endpoint in pull mode.
includedVolumes []object
IncludedVolumes lists the volumes that were included in the backup
dataEndpoint
string
DataEndpoint is the URL of the endpoint for read for pull mode
diskTarget
string required
DiskTarget is the disk target device name at backup time
mapEndpoint
string
MapEndpoint is the URL of the endpoint for map for pull mode
volumeName
string required
VolumeName is the volume name from VMI spec
type
string
Type indicates if the backup was full or incremental
No matches. Try .spec.forceFullBackup for an exact path