Custom Resource Definition - Application

API reference for Trilio Application

Deprecated Documentation

This document is deprecated and no longer supported. For accurate, up-to-date information, please refer to the documentation for the latest version of Trilio.

# Custom Resource Definition - Application

Packages: triliovault.trilio.io/v1

Package v1 contains API Schema definitions for the triliocrds v1 API group. Resource Types are as follows:

ActionFlags

(Appears on: ClusterRestoreSpec, RestoreSpec)

Field	Description
cleanupOnFailure bool	CleanupOnFailure is flag to perform cleanup after restore fails. Defaults to false
protectRestoredApp bool	ProtectRestoredApp decides if T4K will setup a backupPlan to protect the restored application.

ApplicationType (string alias)

(Appears on: BackupPlanStatus, BackupStatus, RestoreStatus)

ApplicationType specifies type of a Backup of an application

Backup

Backup represents the capture of Kubernetes BackupPlan defined by user at a point in time

Field	Description
	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec BackupSpec
type BackupType	Type is the type of backup in the sequence of backups of an Application.
	BackupPlan is a reference to the BackupPlan to be backed up.
type BackupType	Type is the type of backup in the sequence of backups of an Application.
	BackupPlan is a reference to the BackupPlan to be backed up.
type BackupType	Type is the type of backup in the sequence of backups of an Application.
	BackupPlan is a reference to the BackupPlan to be backed up.
status BackupStatus

BackupComponent

(Appears on: BackupComponentInfo, ClusterBackupPlanSpec)

BackupComponent defines the namespace and their configurations for backup

Field	Description
namespace string
hookConfig HookConfig	hookConfig defines backup pre/post hooks and their configurations.
includeResources ResourceSelector	IncludeResources specifies the resources included during backup
excludeResources ResourceSelector	ExcludedResources specifies the resources excluded during backup

BackupComponentInfo

Field	Description
BackupComponent BackupComponent
PartOf BackupPlanSelector
Name string

BackupCondition

(Appears on: BackupStatus)

BackupCondition specifies the current condition of a backup resource.

Field	Description
status Status	Status is the status of the condition.
	Timestamp is the time a condition occurred.
reason string	A brief message indicating details about why the component is in this condition.
phase OperationType	Phase defines the current phase of the controller. nolint:lll // directive continuation

BackupConfig

(Appears on: BackupPlanSpec)

BackupConfig defines the require configuration for taking the backup such as target and retention policy. NOTE: ClusterBackupConfig field in clusterbackupplan_types.go is similar to this structure. Changes made here might be required to be reflected there as well.

Field	Description
	Target is the object reference for the backup target resources
	RetentionPolicy is the object reference for the policy of type retention defined
schedulePolicy SchedulePolicy	SchedulePolicy includes the object references of 2 type of cron schedule policy: incremental and full
maxIncrBackupsPerFullBackup byte	MaxIncrBackupsPerFullBackup is the number of incremental backups after which full backup will ge triggered. This is relevant only in case of immutable backups

BackupInfo

(Appears on: ClusterBackupStatus)

BackupInfo contains the relevant information to uniquely identify a child Backup created from a ClusterBackup

Field	Description
	Backup ObjectReference of child Backup
status Status	Status status of child Backup
percentageCompletion byte	PercentageCompletion is the amount of backup operation completed.
location string	Location is the Backup’s location on the target

BackupPlan

BackupPlan is the Schema for the BackupPlan API

Field	Description
	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec BackupPlanSpec
backupNamespace string	Namespace is the namespace from where the components of backupPlan to be selected Deprecated: After removal of cluster scope CRD support, Backup namespace will be same as BackupPlan namespace.
backupConfig BackupConfig	BackupConfig is the type containing the object references for all the configurations needed for backup operation
backupPlanComponents BackupPlanComponents	BackupPlanComponents includes all the components which defines this BackupPlan i.e Helm charts, operators and label based resources
hookConfig HookConfig	hookConfig defines backup pre/post hooks and their configurations.
includeResources ResourceSelector	IncludeResources specify resources to include for namespace scope backup based on LabelSelector & GVKSelector
excludeResources ResourceSelector	ExcludeResources specify resources to exclude for namespace scope backup based on LabelSelector & GVKSelector
encryption Encryption	Encryption specify how to encrypt backups on target for this backupPlan
backupNamespace string	Namespace is the namespace from where the components of backupPlan to be selected Deprecated: After removal of cluster scope CRD support, Backup namespace will be same as BackupPlan namespace.
backupConfig BackupConfig	BackupConfig is the type containing the object references for all the configurations needed for backup operation
backupPlanComponents BackupPlanComponents	BackupPlanComponents includes all the components which defines this BackupPlan i.e Helm charts, operators and label based resources
hookConfig HookConfig	hookConfig defines backup pre/post hooks and their configurations.
includeResources ResourceSelector	IncludeResources specify resources to include for namespace scope backup based on LabelSelector & GVKSelector
excludeResources ResourceSelector	ExcludeResources specify resources to exclude for namespace scope backup based on LabelSelector & GVKSelector
encryption Encryption	Encryption specify how to encrypt backups on target for this backupPlan
backupNamespace string	Namespace is the namespace from where the components of backupPlan to be selected Deprecated: After removal of cluster scope CRD support, Backup namespace will be same as BackupPlan namespace.
backupConfig BackupConfig	BackupConfig is the type containing the object references for all the configurations needed for backup operation
backupPlanComponents BackupPlanComponents	BackupPlanComponents includes all the components which defines this BackupPlan i.e Helm charts, operators and label based resources
hookConfig HookConfig	hookConfig defines backup pre/post hooks and their configurations.
includeResources ResourceSelector	IncludeResources specify resources to include for namespace scope backup based on LabelSelector & GVKSelector
excludeResources ResourceSelector	ExcludeResources specify resources to exclude for namespace scope backup based on LabelSelector & GVKSelector
encryption Encryption	Encryption specify how to encrypt backups on target for this backupPlan
status BackupPlanStatus

BackupPlanComponents

(Appears on: BackupPlanSpec)

BackupPlanComponents contains the 3 types of components, helm charts, operators and custom label-based resources

Field	Description
helmReleases []string	HelmReleases is the list of release names
operators []OperatorSelector	Operators is the list of operator names and their selectors
	Deprecated: Custom is the combination of label selectors including match labels and match expressions
customSelector CustomSelector	CustomSelector specify resource selection for custom resources, This is the combination of LabelSelector including match labels and match expressions and GVKSelector which could be GroupVersionKind & Objects

BackupPlanInfo

(Appears on: ClusterBackupPlanStatus)

BackupPlanInfo defines the object reference and status of a backupPlan

Field	Description
	BackupPlan is the object reference of a backupPlan
partOf BackupPlanSelector	PartOf specify how backupPlan is selected, it could be by NamespaceSelector or by BackupComponent
name string	Name will specify namespace selector’s name if backupPlan is PartOf NamespaceSelector Name will be empty if backupPlan is PartOf BackupComponents
status Status	Status is the status of the backupPlan

BackupPlanSelector (string alias)

(Appears on: BackupComponentInfo, BackupPlanInfo)

BackupPlanSelector used in ClusterBackupPlan Status to identify how corresponding backupPlan is selected by, it could be by NamespaceSelector or by BackupComponent

BackupPlanSpec

(Appears on: BackupPlan)

BackupPlanSpec defines the desired state of BackupPlan

Field	Description
backupNamespace string	Namespace is the namespace from where the components of backupPlan to be selected Deprecated: After removal of cluster scope CRD support, Backup namespace will be same as BackupPlan namespace.
backupConfig BackupConfig	BackupConfig is the type containing the object references for all the configurations needed for backup operation
backupPlanComponents BackupPlanComponents	BackupPlanComponents includes all the components which defines this BackupPlan i.e Helm charts, operators and label based resources
hookConfig HookConfig	hookConfig defines backup pre/post hooks and their configurations.
includeResources ResourceSelector	IncludeResources specify resources to include for namespace scope backup based on LabelSelector & GVKSelector
excludeResources ResourceSelector	ExcludeResources specify resources to exclude for namespace scope backup based on LabelSelector & GVKSelector
encryption Encryption	Encryption specify how to encrypt backups on target for this backupPlan

BackupPlanStats

(Appears on: BackupPlanStatus)

BackupPlanStats defines the stats for a BackupPlan

Field	Description
backupSummary BackupSummary
restoreSummary RestoreSummary
immutable bool	Immutable specify whether a backup data is going to be immutable.

BackupPlanStatus

(Appears on: BackupPlan)

BackupPlanStatus defines the observed state of BackupPlan

Field	Description
status Status	Status defines the status oif the application resource as available when no operation is running and unavailable when a backup or restore operation is in progress
scope ComponentScope	Scope indicates scope of component in BackupPlan i.e. App or Namespace.
applicationType ApplicationType	ApplicationType is the type of BackupPlan defining backup
	Deprecated: IncrementalCron will be used as an list of references of Crons
	Deprecated: FullBackupCron will be used as an list of references of Crons
stats BackupPlanStats

BackupScheduleType (string alias)

BackupScheduleType specifies the type of schedule which triggered the backup

BackupSpec

(Appears on: Backup)

BackupSpec defines the desired state of Backup

Field	Description
type BackupType	Type is the type of backup in the sequence of backups of an Application.
	BackupPlan is a reference to the BackupPlan to be backed up.

BackupStats

(Appears on: BackupStatus)

BackupStats specifies the stats of a Backup

Field	Description
	Target is the reference to a Target backuped up Deprecated: Target information moved to TargetInfo field
targetInfo TargetInfo	TargetInfo is the information to a Target backed up
	LatestInProgressRestore is the reference to the latest InProgress Restore of a Backup
	LatestCompletedRestore is the reference to the latest Completed Restore of a Backup
hookExists bool	HookExists is a bool value that states if a backup has hooks in backup plan
encryption Encryption	Encryption specifies encryption details of a backup
immutable bool	Immutable specify whether a backup data is immutable

BackupStatus

(Appears on: Backup)

BackupStatus defines the observed state of Backup

Field	Description
backupScope ComponentScope	BackupScope indicates scope of component in backup i.e. App or Namespace.
applicationType ApplicationType	ApplicationType is the type of Application backed up in the App Scoped backup
type BackupType	Type indicates the backup type in backup i.e. Full, Incremental or Mixed.
location string	Location is the absolute path of the target where backup resides.
	StartTimestamp is the time a backup was started.
	CompletionTimestamp is the time a backup was finished.
phase OperationType	Phase is the current phase of the backup operation.
phaseStatus Status	PhaseStatus is the status of phase backup operation going through.
status Status	Status is the status of the backup operation.
	Size is the aggregate size of the data backuped up.
percentageCompletion byte	PercentageCompletion is the amount of backup operation completed.
	ExpirationTimeStamp is the time a backup will not be available after retention.
snapshot Snapshot	Todo: Do we need this option as optional one? Todo: This is optional because, we are allowing the custom backup as empty Snapshot specifies the contents of captured backup.
condition []BackupCondition	Condition is the current condition of hooks while backup.
hookStatus HookComponentStatus	HookStatus specifies pre/post hook execution status for current backup.
stats BackupStats
	Duration is the amount of time the backup process took to finish.

BackupSummary

(Appears on: BackupPlanStats)

BackupSummary comprises of backup object references and count of backups with different statuses

Field	Description
	InProgressBackup is the reference to an InProgress backup of a BackupPlan
	LastSuccessfulBackup is the reference to Latest available Backup of a BackupPlan
	LatestBackup is the reference to Latest Backup in any state, of a BackupPlan
totalAvailableBackups uint32	TotalAvailableBackups is the count of total number of Available Backups
totalFailedBackups uint32	TotalFailedBackups is the count of total number of InProgress Backups
totalQueuedBackups uint32	TotalQueuedBackups is the count of total number of Queued Backups
pvcExistsForBackup bool	PVCExistsForBackup is a bool value that states if the latest backup of a backup plan has PVCs in its data component

BackupType (string alias)

(Appears on: BackupSpec, BackupStatus, ClusterBackupSpec, ClusterBackupStatus, DataSnapshot)

BackupType defines the type backup instance of an BackupPlan

CleanupConfig

(Appears on: PolicySpec)

CleanupConfig is the configuration for the PolicyType: Cleanup

Field	Description
backupDays int	BackupDays is the age of backups to be cleaned

ClusterBackup

ClusterBackup is the Schema for the ClusterBackup API

Field	Description
	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec ClusterBackupSpec
type BackupType	Type is the type of clusterBackup in the sequence of clusterBackups.
	ClusterBackupPlan is a reference to the ClusterBackupPlan to be backed up.
type BackupType	Type is the type of clusterBackup in the sequence of clusterBackups.
	ClusterBackupPlan is a reference to the ClusterBackupPlan to be backed up.
type BackupType	Type is the type of clusterBackup in the sequence of clusterBackups.
	ClusterBackupPlan is a reference to the ClusterBackupPlan to be backed up.
status ClusterBackupStatus

ClusterBackupCondition

(Appears on: ClusterBackupStatus)

ClusterBackupCondition specifies the current condition of a clusterBackup resource.

Field	Description
phase OperationType	Phase defines the current phase of the controller.
status Status	Status is the status of the condition.
	Timestamp is the time a condition occurred.
reason string	A brief message indicating details about why clusterBackup is in this condition.

ClusterBackupConfig

(Appears on: ClusterBackupPlanSpec)

ClusterBackupConfig defines the require configuration for taking the backup such as target and retention policy. NOTE: BackupConfig field in backupplan_types.go is similar to this structure. Changes made here might be required to be reflected there as well.

Field	Description
	Target is the object reference for the backup target resources
	RetentionPolicy is the object reference for the policy of type retention defined
schedulePolicy ClusterBackupSchedulePolicy	SchedulePolicy includes the object references of 2 type of cron schedule policy: incremental and full
maxIncrBackupsPerFullBackup byte	MaxIncrBackupsPerFullBackup is the number of incremental backups after which full backup will ge triggered. This is relevant only in case of immutable backups

ClusterBackupPlan

ClusterBackupPlan is the Schema for the ClusterBackupPlan API

Field	Description
	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec ClusterBackupPlanSpec
backupComponents []BackupComponent	BackupComponents defines all the BackupComponents for which backups are to be taken. It includes namespaces and their configurations
namespaceSelector []NamespaceSelector	NamespaceSelector defines namespaces for which backups are to be taken based on NamespaceSelector(labels & match expression) & their configurations
backupConfig ClusterBackupConfig	BackupConfig is the type containing the object references for all the configurations needed for backup operation
includeResources ResourceSelector	IncludeResources specifies the resources to be explicitly included during backup
excludeResources ResourceSelector	ExcludedResources specifies the resources to be excluded from the backup
encryption Encryption	Encryption specify how to encrypt backups on target for this backupPlan
backupComponents []BackupComponent	BackupComponents defines all the BackupComponents for which backups are to be taken. It includes namespaces and their configurations
namespaceSelector []NamespaceSelector	NamespaceSelector defines namespaces for which backups are to be taken based on NamespaceSelector(labels & match expression) & their configurations
backupConfig ClusterBackupConfig	BackupConfig is the type containing the object references for all the configurations needed for backup operation
includeResources ResourceSelector	IncludeResources specifies the resources to be explicitly included during backup
excludeResources ResourceSelector	ExcludedResources specifies the resources to be excluded from the backup
encryption Encryption	Encryption specify how to encrypt backups on target for this backupPlan
backupComponents []BackupComponent	BackupComponents defines all the BackupComponents for which backups are to be taken. It includes namespaces and their configurations
namespaceSelector []NamespaceSelector	NamespaceSelector defines namespaces for which backups are to be taken based on NamespaceSelector(labels & match expression) & their configurations
backupConfig ClusterBackupConfig	BackupConfig is the type containing the object references for all the configurations needed for backup operation
includeResources ResourceSelector	IncludeResources specifies the resources to be explicitly included during backup
excludeResources ResourceSelector	ExcludedResources specifies the resources to be excluded from the backup
encryption Encryption	Encryption specify how to encrypt backups on target for this backupPlan
status ClusterBackupPlanStatus

ClusterBackupPlanCondition

(Appears on: ClusterBackupPlanStatus)

ClusterBackupPlanCondition specifies the current condition of a cluster backup plan resource.

Field	Description
status Status	Status is the status of the condition.
	Timestamp is the time a condition occurred.
reason string	A brief message indicating details about why the component is in this condition.

ClusterBackupPlanSpec

(Appears on: ClusterBackupPlan)

ClusterBackupPlanSpec defines the desired state of ClusterBackupPlan

Field	Description
backupComponents []BackupComponent	BackupComponents defines all the BackupComponents for which backups are to be taken. It includes namespaces and their configurations
namespaceSelector []NamespaceSelector	NamespaceSelector defines namespaces for which backups are to be taken based on NamespaceSelector(labels & match expression) & their configurations
backupConfig ClusterBackupConfig	BackupConfig is the type containing the object references for all the configurations needed for backup operation
includeResources ResourceSelector	IncludeResources specifies the resources to be explicitly included during backup
excludeResources ResourceSelector	ExcludedResources specifies the resources to be excluded from the backup
encryption Encryption	Encryption specify how to encrypt backups on target for this backupPlan

ClusterBackupPlanStats

(Appears on: ClusterBackupPlanStatus)

ClusterBackupPlanStats defines the stats for a ClusterBackupPlan

Field	Description
clusterBackupSummary ClusterBackupSummary
clusterRestoreSummary ClusterRestoreSummary
immutable bool	Immutable specify whether a backup data is going to be immutable

ClusterBackupPlanStatus

(Appears on: ClusterBackupPlan)

ClusterBackupPlanStatus defines the observed state of ClusterBackupPlan

Field	Description
status Status	Status defines the current state of the ClusterBackupPlan resource. Available state ClusterBackupPlan only can be used for ClusterBackup
backupPlans map[string]github.com/trilioData/k8s-triliovault/api/v1.BackupPlanInfo	BackupPlans is the map of backupPlan name and its object ref managed by cluster backup plan
condition []ClusterBackupPlanCondition	Condition is the current condition of a cluster backup plan.
stats ClusterBackupPlanStats

ClusterBackupSchedulePolicy

(Appears on: ClusterBackupConfig)

ClusterBackupSchedulePolicy contains the object references for incremental or full backup type schedule policy

Field	Description
	IncrementalBackupPolicy is the object reference for the policy of type schedule defined
	FullBackupPolicy is the object reference for the policy of type schedule defined

ClusterBackupSpec

(Appears on: ClusterBackup)

ClusterBackupSpec defines the desired state of ClusterBackup

Field	Description
type BackupType	Type is the type of clusterBackup in the sequence of clusterBackups.
	ClusterBackupPlan is a reference to the ClusterBackupPlan to be backed up.

ClusterBackupStats

(Appears on: ClusterBackupStatus)

ClusterBackupStats specifies the stats of a ClusterBackup

Field	Description
	Target is the reference to a Target backuped up Deprecated: Target information moved to TargetInfo field
targetInfo TargetInfo	TargetInfo is the information to a Target backed up
	LatestInProgressClusterRestore is the reference to the latest InProgress ClusterRestore of a ClusterBackup
	LastCompletedClusterRestore is the reference to the latest Completed ClusterRestore of a ClusterBackup
hookExists bool	HookExists is a bool value that states if a ClusterBackup has hooks in ClusterBackupPlan
encryption Encryption	Encryption specifies encryption details of a ClusterBackup
immutable bool	Immutable specify whether a clusterBackup data is immutable

ClusterBackupStatus

(Appears on: ClusterBackup)

ClusterBackupStatus defines the observed state of ClusterBackup

Field	Description
type BackupType	Type indicates the ClusterBackup type in backup i.e. Full, Incremental or Mixed.
location string	Location is the absolute path of the target where backup resides.
	StartTimestamp is the time when ClusterBackup was started.
	CompletionTimestamp is the time when ClusterBackup finished.
status Status	Status is the status of the ClusterBackup operation.
	Size is the aggregate size of the data backuped up.
percentageCompletion byte	PercentageCompletion is the percentage of ClusterBackup operation completed.
	ExpirationTimeStamp is the time after which a ClusterBackup will not be available after retention.
condition []ClusterBackupCondition	Condition is the conditions a ClusterBackup goes through during backup TODO: Define a separate condition struct
	Duration is the amount of time the ClusterBackup process took to finish.
backupInfos map[string]github.com/trilioData/k8s-triliovault/api/v1.BackupInfo	BackupInfos contains the information of the child Backup CRs created by this ClusterBackup
stats ClusterBackupStats

ClusterBackupSummary

(Appears on: ClusterBackupPlanStats)

ClusterBackupSummary comprises of ClusterBackup object references and count of ClusterBackups with different statuses

Field	Description
	InProgressClusterBackup is the reference to an InProgress ClusterBackup of a ClusterBackupPlan
	LastSuccessfulClusterBackup is the reference to Latest available ClusterBackup of a ClusterBackupPlan
	LatestClusterBackup is the reference to Latest ClusterBackup in any state, of a ClusterBackupPlan
totalAvailableClusterBackups uint32	TotalAvailableClusterBackups is the count of total number of Available ClusterBackups
totalFailedClusterBackups uint32	TotalFailedClusterBackups is the count of total number of Failed ClusterBackups.
totalQueuedClusterBackups uint32	TotalQueuedClusterBackups is the count of total number of Queued ClusterBackups.
pvcExistsForBackup bool	PVCExistsForBackup is a bool value that states if the latest clusterBackup of a clusterBackupPlan has any backup that has PVCs in its data component

ClusterRestore

ClusterRestore defines the desired state of ClusterRestore

Field	Description
	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec ClusterRestoreSpec
source ClusterRestoreSource	Type is the type of source for ClusterRestore
globalConfig RestoreConfig	GlobalConfig is the global restore configuration which is applicable for the components of restore unless explicitly overridden at the component level
components []ComponentConfig	Components defines the components and their custom configuration using which individual component restore is to be done
excludeComponents []string	ExcludeComponents specifies the components(namespaces) to be excluded from the ClusterRestore
cleanupOnFailure bool	CleanupOnFailure is flag to perform cleanup for all restores when ClusterRestore has failed. Deprecated: CleanupOnFailure flag is now moved under ActionFlags struct
actionFlags ActionFlags
encryption Encryption	Encryption specify encryption key to decrypt the encrypted data.
source ClusterRestoreSource	Type is the type of source for ClusterRestore
globalConfig RestoreConfig	GlobalConfig is the global restore configuration which is applicable for the components of restore unless explicitly overridden at the component level
components []ComponentConfig	Components defines the components and their custom configuration using which individual component restore is to be done
excludeComponents []string	ExcludeComponents specifies the components(namespaces) to be excluded from the ClusterRestore
cleanupOnFailure bool	CleanupOnFailure is flag to perform cleanup for all restores when ClusterRestore has failed. Deprecated: CleanupOnFailure flag is now moved under ActionFlags struct
actionFlags ActionFlags
encryption Encryption	Encryption specify encryption key to decrypt the encrypted data.
source ClusterRestoreSource	Type is the type of source for ClusterRestore
globalConfig RestoreConfig	GlobalConfig is the global restore configuration which is applicable for the components of restore unless explicitly overridden at the component level
components []ComponentConfig	Components defines the components and their custom configuration using which individual component restore is to be done
excludeComponents []string	ExcludeComponents specifies the components(namespaces) to be excluded from the ClusterRestore
cleanupOnFailure bool	CleanupOnFailure is flag to perform cleanup for all restores when ClusterRestore has failed. Deprecated: CleanupOnFailure flag is now moved under ActionFlags struct
actionFlags ActionFlags
encryption Encryption	Encryption specify encryption key to decrypt the encrypted data.
status ClusterRestoreStatus

ClusterRestoreCondition

(Appears on: ClusterRestoreStatus)

Field	Description
phase OperationType	Phase defines the current phase of the controller.
status Status	Status is the status of the cluster restore.
	Timestamp is the time a condition occurred.
reason string	A brief message indicating details about why the component is in this condition.

ClusterRestoreSource

(Appears on: ClusterRestoreSpec)

Field	Description
type ClusterRestoreSourceType	Type is the type of source for restore
	ClusterBackup is a reference to the ClusterBackup instance restored if type is ClusterBackup.
	Target is a reference to the Target instance where from restore is performed if type is Location.
location string	Location is an absolute path to remote target from where restore is performed if type is Location.
	ClusterBackupPlan is a reference to the ClusterBackupPlan whose latest successful backup is to be restored.

ClusterRestoreSourceType (string alias)

(Appears on: ClusterRestoreSource)

ClusterRestoreSpec

(Appears on: ClusterRestore)

ClusterRestoreSpec defines the source from where the ClusterRestore is to be done

Field	Description
source ClusterRestoreSource	Type is the type of source for ClusterRestore
globalConfig RestoreConfig	GlobalConfig is the global restore configuration which is applicable for the components of restore unless explicitly overridden at the component level
components []ComponentConfig	Components defines the components and their custom configuration using which individual component restore is to be done
excludeComponents []string	ExcludeComponents specifies the components(namespaces) to be excluded from the ClusterRestore
cleanupOnFailure bool	CleanupOnFailure is flag to perform cleanup for all restores when ClusterRestore has failed. Deprecated: CleanupOnFailure flag is now moved under ActionFlags struct
actionFlags ActionFlags
encryption Encryption	Encryption specify encryption key to decrypt the encrypted data.

ClusterRestoreStats

(Appears on: ClusterRestoreStatus)

ClusterRestoreStats defines the stats for a RestorCluster

Field	Description
	ClusterBackupPlan is the reference to ClusterBackupPlan associated with ClusterRestore
	ClusterBackup is the reference to the ClusterBackup associated with ClusterRestore

ClusterRestoreStatus

(Appears on: ClusterRestore)

ClusterRestoreStatus defines the observed state of ClusterRestore

Field	Description
	StartTimestamp is the time when ClusterRestore was started.
	CompletionTimestamp is the time when ClusterRestore finished.
phase OperationType	Phase is the current phase of the ClusterRestore operation.
phaseStatus Status	PhaseStatus is the status of phase ClusterRestore operation going through.
status Status	Status is the status of the ClusterRestore operation.
	Size is the aggregate size of the data restored back.
percentageCompletion byte	PercentageCompletion is the percentage of ClusterRestore operation completed.
condition []ClusterRestoreCondition	Condition is the overall condition of cluster restore resource.
	Duration is the amount of time the ClusterRestore process took to finish.
components map[string]github.com/trilioData/k8s-triliovault/api/v1.ComponentInfo	ComponentInfos contains information related to each individual backup to be restored
createdNamespaces []string	CreatedNamespaces are the namespaces created for restores.
stats ClusterRestoreStats
protectingResources []Resource	ProtectingResources lists the Trilio resources and dependent resources which are getting created after user cluster restore operation. It’s applicable only if ProtectRestoredApp is set to true.

ClusterRestoreSummary

(Appears on: ClusterBackupPlanStats)

ClusterRestoreSummary comprises of ClusterRestore object references and count of ClusterRestore with different statuses

Field	Description
	LastSuccessfulClusterRestore is the reference to Latest completed ClusterRestore of a ClusterBackupPlan
totalInProgressClusterRestores uint32	TotalInProgressClusterRestores is the count of total number of InProgress ClusterRestores
totalCompletedClusterRestores uint32	TotalCompletedClusterRestores is the count of total number of Completed ClusterRestores
totalFailedClusterRestores uint32	TotalFailedClusterRestores is the count of total number of Failed ClusterRestores

ComponentConfig

(Appears on: ClusterRestoreSpec)

Field	Description
backupNamespace string
restoreNamespace string
restoreConfig RestoreConfig
hookConfig HookConfig

ComponentInfo

(Appears on: ClusterRestoreStatus)

Field	Description
location string	Location is the location of the backup on target.
	Backup is the reference of the Backup CR used for backing up this component
	Restore is the reference of the Restore CR used for restoring this component.
restoreStatus Status	Status is the status of particular restore.
percentageCompletion byte	PercentageCompletion is the amount of restore operation completed.

ComponentScope (string alias)

(Appears on: BackupPlanStatus, BackupStatus, RestoreStatus)

ComponentScope indicates scope of components i.e. [App or Namespace] present in backup or restore

ComponentStatus

(Appears on: RestoreCustom, RestoreHelm, RestoreOperator)

ComponentStatus defines the details of restore of application component.

Field	Description
existingResource []Resource	ExistingResource specifies the resources already existing in cluster defined in application.
skippedResources []Resource	SkippedResources specifies the resources skipped while restoring.
failedResources []Resource	FailedResources specifies the resources for which the restore operation failed
newResourcesAdded []Resource	NewResourcesAdded specifies the resources added(duplicated and modified) during restore.
excludedResources []Resource	ExcludedResources specifies the resources excluded during restore
failedCleanupResources []Resource	FailedCleanupResources specified the resources which doesn’t get clean up in failed restore
transformStatus []TransformStatus	TransformStatus is the status of transformation performed
phase RestorePhase	Phase is the current phase of the application component while restore.
phaseStatus Status	PhaseStatus is the status of phase restore operation going through.
reason string	A brief message indicating details about why the application component is in this state.

Conditions

(Appears on: DataSnapshot)

Field	Description
status Status	Status is the status of the condition.
	Timestamp is the time a condition occurred.
reason string	A brief message indicating details about why the component is in this condition.
phase OperationType	Phase defines the current phase of the data components.

ContainerHookStatus

(Appears on: PodHookStatus)

ContainerHookStatus defines hook execu