ApplicationBackup CRD reference

ApplicationBackup represents applicationbackup object.

ApplicationBackup

Field	Description	Type
apiVersion	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	string
kind	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	string
spec	ApplicationBackupSpec is the spec used to backup applications	object
status	ApplicationBackupStatus is the status of an application backup operation	object

spec fields

Field	Description	Type
spec.advancedResourceLabelSelector	AdvancedResourceLabelSelector define label-based filters to determine which resources should be included in the backup. Make this as string type, so that we can support all combination of label selectors.	string
spec.backupLocation	BackupLocation is the name of the backup storage location where the backup will be stored.	string
spec.backupObjectType	BackupObjectType set to All for Namespace backup, VirtualMachine for VM specific Backup	string
spec.backupType	BackupType specifies the type of backup to be performed	string
spec.csiSnapshotClassMap	CSISnapshotClassMap is 1 to 1 Map of CSI Provisioner to its Corresponding VolumeSnapshotClass to be used for backup	object
spec.directKDMP	DirectKDMP indicates whether backups should use direct KDMP (Kubernetes Data Mover Plugin) for data movement.	boolean
spec.excludeResourceTypes	ExcludeResourceTypes lists resource types that should be explicitly excluded from the backup.	array
spec.includeResources	IncludeResources specifies the list of individual resources to be explicitly included in the backup.	array
spec.keepCrStatus	KeepCrStatus is false by default, if set true will keep the CR status of the resources in the backup.	boolean
spec.missingNamespaces	MissingNamespaces stores the list of namespaces that are not found in the cluster during the start of the backup cycle	array
spec.namespaceSelector	NamespaceSelector specifies a label selector to filter namespaces for the backup.	string
spec.namespaces	Namespaces specifies the list of Kubernetes namespaces to be backed up.	array
spec.options	Options to be passed in to the driver	object
spec.platformCredential	PlatformCredential specifies the credential to be used for authenticating with the underlying platform.	string
spec.postExecRule	PostExecRule is the name of a rule to be executed after the backup completes.	string
spec.preExecRule	PreExecRule is the name of a rule to be executed before the backup starts.	string
spec.rancherProjects	RancherProjects maps Kubernetes namespaces to their corresponding Rancher projects.	object
spec.reclaimPolicy	ReclaimPolicy determines the behavior of backup objects upon deletion. Possible values include: - Retain: Keeps the backup data even after the backup object is deleted. - Delete: Deletes the backup data when the backup object is deleted.	string
spec.resourceTypes	ResourceTypes defines the types of resources to be backed up (e.g., Pods, Services, PVCs).	array
spec.selectors	Selectors define label-based filters to determine which resources should be included in the backup.	object
spec.skipAutoExecRules	SkipAutoExecRules is false by default, if set true will skip auto exec rules for VM specific backup. This field is unused for non VM specific Backup.	boolean
spec.skipServiceUpdate	SkipServiceUpdate specifies whether service updates should be skipped during the backup process.	boolean
spec.volumeResourceOnlyPolicy	VolumeResourceOnlyPolicy specifies the policy configuration that will be used for skipping data backup for some of the volume configuration.	string

status fields

Field	Description	Type
status.namespaceBackupResourceInfo	NamespaceBackupResourceInfo contains detailed resource information for namespace backups	array
status.namespaceBackupResourceInfo.metrics	Metrics contains statistics for this namespace	object
status.namespaceBackupResourceInfo.metrics.totalFailedResources	TotalFailedResources is the total number of resources that failed	integer
status.namespaceBackupResourceInfo.metrics.totalFailedVolumes	TotalFailedVolumes is the total number of volumes that failed	integer
status.namespaceBackupResourceInfo.metrics.totalResources	TotalResources is the total number of resources	integer
status.namespaceBackupResourceInfo.metrics.totalVolumes	TotalVolumes is the total number of volumes	integer
status.namespaceBackupResourceInfo.namespace	Namespace is the namespace name	string
status.namespaceBackupResourceInfo.resourceTypes	ResourceTypes is the list of resource types in this namespace	array
status.namespaceBackupResourceInfo.resourceTypes.chunks	Chunks is the list of chunks containing resources of this type	array
status.namespaceBackupResourceInfo.resourceTypes.chunks.id	ID is the chunk identifier	integer
status.namespaceBackupResourceInfo.resourceTypes.chunks.resourceNames	ResourceNames is the list of resource names contained in this chunk	array
status.namespaceBackupResourceInfo.resourceTypes.chunks.status	Status is the processing status of this specific chunk	object
status.namespaceBackupResourceInfo.resourceTypes.chunks.status.reason	Reason provides additional context for the status	string
status.namespaceBackupResourceInfo.resourceTypes.chunks.status.status	Status is the current status of the chunk	string
status.namespaceBackupResourceInfo.resourceTypes.chunks.totalResources	TotalResources is the total number of resources in this chunk	integer
status.namespaceBackupResourceInfo.resourceTypes.metrics	Metrics contains statistics for this resource type	object
status.namespaceBackupResourceInfo.resourceTypes.metrics.totalFailedResources	TotalFailedResources is the total number of resources of this type that failed	integer
status.namespaceBackupResourceInfo.resourceTypes.metrics.totalResources	TotalResources is the total number of resources of this type	integer
status.namespaceBackupResourceInfo.resourceTypes.name	Name is the Kubernetes resource type in the format group/version/kind (e.g., "apps/v1/Deployment")	string
status.namespaceBackupResourceInfo.status	Status information for this namespace	object
status.namespaceBackupResourceInfo.status.reason	Reason provides additional context for the status	string
status.namespaceBackupResourceInfo.status.status	Status is the current status of the namespace backup	string
status.resources.status	ApplicationBackupStatusType is the status of the application backup	string
status.stage	ApplicationBackupStageType is the stage of the backup	string
status.status	ApplicationBackupStatusType is the status of the application backup	string
status.virtualMachineBackupResourceInfo	VirtualMachineBackupResourceInfo contains detailed resource information for VM backups	array
status.virtualMachineBackupResourceInfo.metrics	Metrics contains statistics for this namespace in VM backup	object
status.virtualMachineBackupResourceInfo.metrics.totalFailedResources	TotalFailedResources is the total number of resources that failed	integer
status.virtualMachineBackupResourceInfo.metrics.totalFailedVolumes	TotalFailedVolumes is the total number of volumes that failed	integer
status.virtualMachineBackupResourceInfo.metrics.totalResources	TotalResources is the total number of resources	integer
status.virtualMachineBackupResourceInfo.metrics.totalVolumes	TotalVolumes is the total number of volumes	integer
status.virtualMachineBackupResourceInfo.namespace	Namespace is the namespace name	string
status.virtualMachineBackupResourceInfo.resourceTypes	ResourceTypes is the list of resource types in this namespace for VM backup, grouped by resource type	array
status.virtualMachineBackupResourceInfo.resourceTypes.chunks	Chunks is the list of chunks containing resources of this type	array
status.virtualMachineBackupResourceInfo.resourceTypes.chunks.id	ID is the chunk identifier	integer
status.virtualMachineBackupResourceInfo.resourceTypes.chunks.resourceNamesWithLinkedVMs	ResourceNamesWithLinkedVMs is the list of resource names with their linked VM information	array
status.virtualMachineBackupResourceInfo.resourceTypes.chunks.resourceNamesWithLinkedVMs.resourceName	ResourceName is the name of the resource	string
status.virtualMachineBackupResourceInfo.resourceTypes.chunks.resourceNamesWithLinkedVMs.virtualMachineNames	VirtualMachineNames is the list of virtual machine names linked to this resource	array
status.virtualMachineBackupResourceInfo.resourceTypes.chunks.status	Status is the processing status of this specific chunk	object
status.virtualMachineBackupResourceInfo.resourceTypes.chunks.status.reason	Reason provides additional context for the status	string
status.virtualMachineBackupResourceInfo.resourceTypes.chunks.status.status	Status is the current status of the chunk	string
status.virtualMachineBackupResourceInfo.resourceTypes.chunks.totalResources	TotalResources is the total number of resources in this chunk	integer
status.virtualMachineBackupResourceInfo.resourceTypes.metrics	Metrics contains statistics for this resource type	object
status.virtualMachineBackupResourceInfo.resourceTypes.metrics.totalFailedResources	TotalFailedResources is the total number of resources of this type that failed	integer
status.virtualMachineBackupResourceInfo.resourceTypes.metrics.totalResources	TotalResources is the total number of resources of this type	integer
status.virtualMachineBackupResourceInfo.resourceTypes.name	Name is the Kubernetes resource type in the format group/version/kind (e.g., "apps/v1/Deployment")	string
status.virtualMachineBackupResourceInfo.status	Status information for this namespace in VM backup	object
status.virtualMachineBackupResourceInfo.status.reason	Reason provides additional context for the status	string
status.virtualMachineBackupResourceInfo.status.status	Status is the current status of the namespace backup	string
status.virtualMachines.status	ApplicationBackupStatusType is the status of the application backup	string
status.volumes.processedBytesError	ProcessedBytesError indicates if there was an error determining the actual uploaded size. When true, TotalSize and ActualSize should be treated as unreliable.	boolean
status.volumes.status	ApplicationBackupStatusType is the status of the application backup	string
status.volumes.virtualMachineName	VirtualMachineName Stores the VM name that the volume belongs to for VM specific backups	string