ApplicationRestore CRD reference
ApplicationRestore represents applicationrestore object.
ApplicationRestore
| 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 | ApplicationRestoreSpec is the spec used to restore applications | object |
status | ApplicationRestoreStatus is the status of an application restore operation | object |
spec fields
| Field | Description | Type |
|---|---|---|
spec.backupLocation | BackupLocation indicates the backup storage location where the backup is stored. | string |
spec.backupName | BackupName specifies the name of the backup from which the restore will be performed. | string |
spec.backupObjectType | BackupObjectType specifies if its vm specific backup Object for restore. | string |
spec.filter | Filter specifies the filter options to apply during restore. | object |
spec.filter.namespaceFilter | NamespaceFilter specifies namespace-level filtering (for namespace backups only) | object |
spec.filter.namespaceFilter.excludeNamespaces | ExcludeNamespaces specifies namespaces to exclude | array |
spec.filter.namespaceFilter.excludeResources | ExcludeResources specifies explicit resources to exclude (with name, namespace, group, version, kind) | array |
spec.filter.namespaceFilter.gvks | GVKs specifies resource types to filter by (group/version/kind format) Format: "group/version/kind" (e.g., "apps/v1/Deployment") or "version/kind" for core resources (e.g., "v1/Pod") | array |
spec.filter.namespaceFilter.includeNamespaces | IncludeNamespaces specifies namespaces to include | array |
spec.filter.namespaceFilter.includeResources | IncludeResources specifies explicit resources to include (with name, namespace, group, version, kind) | array |
spec.filter.namespaceFilter.namespaceNamePattern | NamespaceNamePattern specifies a regex pattern for namespace names | string |
spec.filter.namespaceFilter.resourceNamePattern | ResourceNamePattern specifies a regex pattern for resource names | string |
spec.includeOptionalResourceTypes | IncludeOptionalResourceTypes lists additional resource types to be included in the restore process. | array |
spec.includeResources | IncludeResources specifies the list of individual resources to be explicitly included in the restore. | array |
spec.isSFR | This is SingleFileRestore specific field to indicate that this restore is for SingleFileRestore | boolean |
spec.keepCrStatus | KeepCrStatus specifies if the CR status should be retained during restore. | boolean |
spec.namespaceMapping | NamespaceMapping provides a mapping between source and destination namespaces. | object |
spec.rancherProjectMapping | RancherProjectMapping maps Kubernetes namespaces to Rancher projects for restoration. | object |
spec.replacePolicy | ReplacePolicy defines the policy for replacing existing resources during the restore process. | string |
spec.storageClassMapping | StorageClassMapping provides a mapping between source and target storage classes. | object |
spec.targetNamespacePrefix | target_namespace_prefix will be used to prefix all the target namespaces when filter is applied Only one of namespace_mapping, target_namespace_prefix can be set at a time | string |
spec.virtualMachineFiles.destinationPath | DestinationPath specifies the target path where the file should be restored | string |
spec.virtualMachineFiles.duration | Duration indicates time taken to restore the file (used in status) | string |
spec.virtualMachineFiles.isDir | Is Directory | boolean |
spec.virtualMachineFiles.partitionInfo | PartitionInfo specifies the partition info (vda1, sda14) if the drive is partitioned | string |
spec.virtualMachineFiles.reason | Reason provides additional information about the status (used in status) | string |
spec.virtualMachineFiles.sourcePath | SourcePath specifies the path of the file in the backup to be restored | string |
spec.virtualMachineFiles.status | Status indicates the current status of this file's restore operation (used in status) | string |
spec.vmRestoreOptions | VmRestoreOptions contains VM-specific restore options (only applicable for VirtualMachine backup type) | object |
spec.vmRestoreOptions.skipMacMasking | SkipMacMasking skips MAC address masking during VM restore | boolean |
spec.vmRestoreOptions.skipVmRestart | SkipVmRestart skips VM restart during restore | boolean |
status fields
| Field | Description | Type |
|---|---|---|
status.reasons | Reasons is a deduplicated list of reason strings referenced by index in ResourceInfo | array |
status.resourceInfo | ResourceInfo contains detailed resource information for restores grouped by namespace, GVK, and status | array |
status.resourceInfo.metrics | Metrics contains statistics for this namespace | object |
status.resourceInfo.metrics.totalFailedResources | TotalFailedResources is the total number of resources that failed | integer |
status.resourceInfo.metrics.totalFailedVolumes | TotalFailedVolumes is the total number of volumes that failed | integer |
status.resourceInfo.metrics.totalResources | TotalResources is the total number of resources | integer |
status.resourceInfo.metrics.totalRetainedResources | TotalRetainedResources is the total number of resources that were retained | integer |
status.resourceInfo.metrics.totalVolumes | TotalVolumes is the total number of volumes | integer |
status.resourceInfo.namespace | Namespace is the namespace name | string |
status.resourceInfo.resourceTypes | ResourceTypes is the list of resource types in this namespace grouped by GVK | array |
status.resourceInfo.resourceTypes.chunks | Chunks is the list of chunks containing resources of this type | array |
status.resourceInfo.resourceTypes.chunks.id | ID is the chunk identifier (from backup) | integer |
status.resourceInfo.resourceTypes.chunks.resourceInfos | ResourceInfos is the list of resources grouped by status | array |
status.resourceInfo.resourceTypes.chunks.resourceInfos.resources | Resources is the list of resources with this status | array |
status.resourceInfo.resourceTypes.chunks.resourceInfos.resources.name | Name is the name of the resource | string |
status.resourceInfo.resourceTypes.chunks.resourceInfos.resources.reasonIndex | ReasonIndex is the index into the Reasons list in ApplicationRestoreStatus A value of 0 indicates no reason | integer |
status.resourceInfo.resourceTypes.chunks.resourceInfos.status | Status is the restore status for this group of resources | string |
status.resourceInfo.resourceTypes.chunks.totalResources | TotalResources is the total number of resources in this chunk | integer |
status.resourceInfo.resourceTypes.metrics | Metrics contains statistics for this resource type (reuses ResourceTypeMetrics from backup) | object |
status.resourceInfo.resourceTypes.metrics.totalFailedResources | TotalFailedResources is the total number of resources of this type that failed | integer |
status.resourceInfo.resourceTypes.metrics.totalResources | TotalResources is the total number of resources of this type | integer |
status.resourceInfo.resourceTypes.name | Name is the Kubernetes resource type in the format group/version/kind (e.g., "apps/v1/Deployment") | string |
status.resourceInfo.status | Status information for this namespace (reuses NamespaceStatusInfo from backup) | object |
status.resourceInfo.status.reason | Reason provides additional context for the status | string |
status.resourceInfo.status.status | Status is the current status of the namespace backup | string |
status.resources.status | ApplicationRestoreStatusType is the status of the application restore | string |
status.singleFileRestoreStatus | SingleFileRestoreStatus is the status of a single file restore operation | object |
status.singleFileRestoreStatus.files.destinationPath | DestinationPath specifies the target path where the file should be restored | string |
status.singleFileRestoreStatus.files.duration | Duration indicates time taken to restore the file (used in status) | string |
status.singleFileRestoreStatus.files.isDir | Is Directory | boolean |
status.singleFileRestoreStatus.files.partitionInfo | PartitionInfo specifies the partition info (vda1, sda14) if the drive is partitioned | string |
status.singleFileRestoreStatus.files.reason | Reason provides additional information about the status (used in status) | string |
status.singleFileRestoreStatus.files.sourcePath | SourcePath specifies the path of the file in the backup to be restored | string |
status.singleFileRestoreStatus.files.status | Status indicates the current status of this file's restore operation (used in status) | string |
status.singleFileRestoreStatus.status | SingleFileRestoreStatusType is the status of the single file restore | string |
status.stage | ApplicationRestoreStageType is the stage of the restore | string |
status.status | ApplicationRestoreStatusType is the status of the application restore | string |
status.volumes.status | ApplicationRestoreStatusType is the status of the application restore | string |