Custom Resource Definition - Application

API reference for Trilio Application

Packages:

• triliovault.trilio.io/v1

triliovault.trilio.io/v1

Package v1 contains API Schema definitions for the triliocrds v1 API group trigger images

Resource Types:

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.
imageRestore bool	ImageRestore is flag to perform the container image restore

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.
	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 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 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 is the type of backup in the sequence of backups of an Application.
	BackupPlan is a reference to the BackupPlan to be backed up.

BackupComponent

(Appears on: BackupComponentInfo, ClusterBackupPlanSpec)

BackupComponent defines the namespace and their configurations for backup

Field	Description
namespace string
	hookConfig defines backup pre/post hooks and their configurations.
	IncludeResources specifies the resources included during backup
	ExcludedResources specifies the resources excluded during backup
retainHelmApps bool	RetainHelmApps is a bool value that states that backup the helm application using helm way while taking namespace backup.

BackupComponentInfo

Field	Description
Name string

BackupCondition

(Appears on: BackupStatus)

BackupCondition specifies the current condition of a backup resource.

Field	Description
	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 defines the current phase of the controller. nolint:lll // directive continuation

BackupConfig

(Appears on: BackupPlanSpec)

BackupConfig defines the required 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 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 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.
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 is the type containing the object references for all the configurations needed for backup operation
	BackupPlanComponents includes all the components which defines this BackupPlan i.e Helm charts, operators and label based resources
	hookConfig defines backup pre/post hooks and their configurations.
	IncludeResources specify resources to include for namespace scope backup based on LabelSelector & GVKSelector. This acts similar like SelectResources used in custom or operators.
	ExcludeResources specify resources to exclude for namespace scope backup based on LabelSelector & GVKSelector
	Encryption specify how to encrypt backups on target for this backupPlan
	SecurityScanConfig defines the Security Scan config to be used for Backup scanning
	ContinuousRestoreConfig defines the Continuous Restore config to be used
retainHelmApps bool	RetainHelmApps is a bool value that states that backup the helm application using helm way while taking namespace backup.
	BackupPlanFlags specifies all the flags specified at the backup plan level.
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 is the type containing the object references for all the configurations needed for backup operation
	BackupPlanComponents includes all the components which defines this BackupPlan i.e Helm charts, operators and label based resources
	hookConfig defines backup pre/post hooks and their configurations.
	IncludeResources specify resources to include for namespace scope backup based on LabelSelector & GVKSelector. This acts similar like SelectResources used in custom or operators.
	ExcludeResources specify resources to exclude for namespace scope backup based on LabelSelector & GVKSelector
	Encryption specify how to encrypt backups on target for this backupPlan
	SecurityScanConfig defines the Security Scan config to be used for Backup scanning
	ContinuousRestoreConfig defines the Continuous Restore config to be used
retainHelmApps bool	RetainHelmApps is a bool value that states that backup the helm application using helm way while taking namespace backup.
	BackupPlanFlags specifies all the flags specified at the backup plan level.
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 is the type containing the object references for all the configurations needed for backup operation
	BackupPlanComponents includes all the components which defines this BackupPlan i.e Helm charts, operators and label based resources
	hookConfig defines backup pre/post hooks and their configurations.
	IncludeResources specify resources to include for namespace scope backup based on LabelSelector & GVKSelector. This acts similar like SelectResources used in custom or operators.
	ExcludeResources specify resources to exclude for namespace scope backup based on LabelSelector & GVKSelector
	Encryption specify how to encrypt backups on target for this backupPlan
	SecurityScanConfig defines the Security Scan config to be used for Backup scanning
	ContinuousRestoreConfig defines the Continuous Restore config to be used
retainHelmApps bool	RetainHelmApps is a bool value that states that backup the helm application using helm way while taking namespace backup.
	BackupPlanFlags specifies all the flags specified at the backup plan level.
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 is the type containing the object references for all the configurations needed for backup operation
	BackupPlanComponents includes all the components which defines this BackupPlan i.e Helm charts, operators and label based resources
	hookConfig defines backup pre/post hooks and their configurations.
	IncludeResources specify resources to include for namespace scope backup based on LabelSelector & GVKSelector. This acts similar like SelectResources used in custom or operators.
	ExcludeResources specify resources to exclude for namespace scope backup based on LabelSelector & GVKSelector
	Encryption specify how to encrypt backups on target for this backupPlan
	SecurityScanConfig defines the Security Scan config to be used for Backup scanning
	ContinuousRestoreConfig defines the Continuous Restore config to be used
retainHelmApps bool	RetainHelmApps is a bool value that states that backup the helm application using helm way while taking namespace backup.
	BackupPlanFlags specifies all the flags specified at the backup plan level.

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 is the list of operator names and their selectors
	Deprecated: Custom is the combination of label selectors including match labels and match expressions
	CustomSelector specify resource selection for custom resources, This is the combination of LabelSelectorincluding match labels and match expressions and GVKSelector which could be GroupVersionKind & Objects

BackupPlanCondition

(Appears on: BackupPlanStatus)

BackupPlanCondition specifies the current condition of a backupPlan resource.

Field	Description
	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 defines the current phase of the controller.

BackupPlanFlags

(Appears on: BackupPlanSpec, ClusterBackupPlanSpec)

Field	Description
skipImageBackup bool	SkipImageBackup is flag to skip the container images backup

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 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 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 is the type containing the object references for all the configurations needed for backup operation
	BackupPlanComponents includes all the components which defines this BackupPlan i.e Helm charts, operators and label based resources
	hookConfig defines backup pre/post hooks and their configurations.
	IncludeResources specify resources to include for namespace scope backup based onLabelSelector & GVKSelector. This acts similar like SelectResources used in custom or operators.
	ExcludeResources specify resources to exclude for namespace scope backup based on LabelSelector & GVKSelector
	Encryption specify how to encrypt backups on target for this backupPlan
	SecurityScanConfig defines the Security Scan config to be used for Backup scanning
	ContinuousRestoreConfig defines the Continuous Restore config to be used
retainHelmApps bool	RetainHelmApps is a bool value that states that backup the helm application using helm way while taking namespace backup.
	BackupPlanFlags specifies all the flags specified at the backup plan level.

BackupPlanStats

(Appears on: BackupPlanStatus)

BackupPlanStats defines the stats for a BackupPlan

Field	Description
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
	Condition is the current condition of a backupPlan.
	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 indicates scope of component in BackupPlan i.e. App or Namespace.
	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
	SecurityScanStatus contains the information of each Security instanceID defined, and it’s Security Scan status
	ContinuousRestoreStatus contains the information of each ContinuousRestore instanceID defined, and it’s ContinuousRestore service status

BackupScanInfo

(Appears on: ScanInstance)

Field	Description
	MetadataScannerStatus is the result of Metadata Scanning It is the mapping of scanner name and its corresponding report
	DataScannerStatus is the result of Data Scanning It is the mapping of scanner name and its corresponding report
	ImageScannerStatus is the result of Image Scanning It is the mapping of scanner name and its corresponding report

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 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 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 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 indicates scope of component in backup i.e. App or Namespace.
	ApplicationType is the type of Application backed up in the App Scoped backup.
	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 is the current phase of the backup operation.
	PhaseStatus is the status of phase backup operation going through.
	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.
	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 is the current condition of hooks while backup.
	HookStatus specifies pre/post hook execution status for current backup.
	SecurityScanStatus contains the information of Security Scan performed for Backup on each Security instanceID defined.
	ConsistentSetStatus contains the mapping of instanceID and the ContinuousRestore performed for Backup on that ContinuousRestore site instance.
	Duration is the amount of time the backup process took to finish.
encryptionEnabled bool	EncryptionEnabled flag shows that encryption is enabled for backup

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, ImageSnapshot)

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.
	Type is the type of clusterBackup in the sequence of clusterBackups.
	ClusterBackupPlan is a reference to the ClusterBackupPlan to be backed up.
	Type is the type of clusterBackup in the sequence of clusterBackups.
	ClusterBackupPlan is a reference to the ClusterBackupPlan to be backed up.
	Type is the type of clusterBackup in the sequence of clusterBackups.
	ClusterBackupPlan is a reference to the ClusterBackupPlan to be backed up.
	Type is the type of clusterBackup in the sequence of clusterBackups.
	ClusterBackupPlan is a reference to the ClusterBackupPlan to be backed up.

ClusterBackupCondition

(Appears on: ClusterBackupStatus)

ClusterBackupCondition specifies the current condition of a clusterBackup resource.

Field	Description
	Phase defines the current phase of the controller.
	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 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.
	BackupComponents defines all the BackupComponents for which backups are to be taken. It includes namespaces and their configurations
	NamespaceSelector defines namespaces for which backups are to be taken based on NamespaceSelector(labels & match expression) & their configurations
	BackupConfig is the type containing the object references for all the configurations needed for backup operation
	IncludeResources specifies the resources to be explicitly included during backup
	ExcludedResources specifies the resources to be excluded from the backup
	Encryption specify how to encrypt backups on target for this backupPlan
	SecurityScanConfig defines the Security Scan config to be used for ClusterBackup scanning
	ContinuousRestoreConfig defines the Continuous Restore config to be used
retainHelmApps bool	RetainHelmApps is a bool value that states that backup the helm application using helm way while taking namespace backup.
	BackupPlanFlags specifies all the flags specified at the cluster backup plan level.
	BackupComponents defines all the BackupComponents for which backups are to be taken. It includes namespaces and their configurations
	NamespaceSelector defines namespaces for which backups are to be taken based on NamespaceSelector(labels & match expression) & their configurations
	BackupConfig is the type containing the object references for all the configurations needed for backup operation
	IncludeResources specifies the resources to be explicitly included during backup
	ExcludedResources specifies the resources to be excluded from the backup
	Encryption specify how to encrypt backups on target for this backupPlan
	SecurityScanConfig defines the Security Scan config to be used for ClusterBackup scanning
	ContinuousRestoreConfig defines the Continuous Restore config to be used
retainHelmApps bool	RetainHelmApps is a bool value that states that backup the helm application using helm way while taking namespace backup.
	BackupPlanFlags specifies all the flags specified at the cluster backup plan level.
	BackupComponents defines all the BackupComponents for which backups are to be taken. It includes namespaces and their configurations
	NamespaceSelector defines namespaces for which backups are to be taken based on NamespaceSelector(labels & match expression) & their configurations
	BackupConfig is the type containing the object references for all the configurations needed for backup operation
	IncludeResources specifies the resources to be explicitly included during backup
	ExcludedResources specifies the resources to be excluded from the backup
	Encryption specify how to encrypt backups on target for this backupPlan
	SecurityScanConfig defines the Security Scan config to be used for ClusterBackup scanning
	ContinuousRestoreConfig defines the Continuous Restore config to be used
retainHelmApps bool	RetainHelmApps is a bool value that states that backup the helm application using helm way while taking namespace backup.
	BackupPlanFlags specifies all the flags specified at the cluster backup plan level.
	BackupComponents defines all the BackupComponents for which backups are to be taken. It includes namespaces and their configurations
	NamespaceSelector defines namespaces for which backups are to be taken based on NamespaceSelector(labels & match expression) & their configurations
	BackupConfig is the type containing the object references for all the configurations needed for backup operation
	IncludeResources specifies the resources to be explicitly included during backup
	ExcludedResources specifies the resources to be excluded from the backup
	Encryption specify how to encrypt backups on target for this backupPlan
	SecurityScanConfig defines the Security Scan config to be used for ClusterBackup scanning
	ContinuousRestoreConfig defines the Continuous Restore config to be used
retainHelmApps bool	RetainHelmApps is a bool value that states that backup the helm application using helm way while taking namespace backup.
	BackupPlanFlags specifies all the flags specified at the cluster backup plan level.

ClusterBackupPlanCondition

(Appears on: ClusterBackupPlanStatus)

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

Field	Description
	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 defines the current phase of the controller.
	Phase defines the current phase of the controller.
	Phase defines the current phase of the controller.
	Phase defines the current phase of the controller.

ClusterBackupPlanSpec

(Appears on: ClusterBackupPlan)

ClusterBackupPlanSpec defines the desired state of ClusterBackupPlan

Field	Description
	BackupComponents defines all the BackupComponents for which backups are to be taken. It includes namespaces and their configurations
	NamespaceSelector defines namespaces for which backups are to be taken based on NamespaceSelector(labels & match expression) & their configurations
	BackupConfig is the type containing the object references for all the configurations needed for backup operation
	IncludeResources specifies the resources to be explicitly included during backup
	ExcludedResources specifies the resources to be excluded from the backup
	Encryption specify how to encrypt backups on target for this backupPlan
	SecurityScanConfig defines the Security Scan config to be used for ClusterBackup scanning
	ContinuousRestoreConfig defines the Continuous Restore config to be used
retainHelmApps bool	RetainHelmApps is a bool value that states that backup the helm application using helm way while taking namespace backup.
	BackupPlanFlags specifies all the flags specified at the cluster backup plan level.

ClusterBackupPlanStats

(Appears on: ClusterBackupPlanStatus)

ClusterBackupPlanStats defines the stats for a ClusterBackupPlan

Field	Description
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 defines the current state of the ClusterBackupPlan resource. Availablestate ClusterBackupPlan only can be used for ClusterBackup
	BackupPlans is the map of backupPlan name and its object ref managed by cluster backup plan
	Condition is the current condition of a cluster backup plan.
	SecurityScanStatus contains the information of each Security instanceID defined, and it’s Security Scan status
	ContinuousRestoreStatus contains the information of each ContinuousRestore instanceID defined, and it’s ContinuousRestore service status

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 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 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 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 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 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 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 contains the information of the child Backup CRs created by this ClusterBackup
	SecurityScanStatus contains the information of Security Scan performed for ClusterBackup on each Security instanceID defined.
	ConsistentSetStatus contains the information of ContinuousRestore performed for ClusterBackup on each ContinuousRestore instanceID defined.
encryptionEnabled bool	EncryptionEnabled flag shows that encryption is enabled for cluster backup

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.
	Type is the type of source for ClusterRestore
	GlobalConfig is the global restore configuration which is applicable for the components of restore unless explicitly overridden at the component level
	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
	Encryption specify encryption key to decrypt the encrypted data.
	ImageRegistry specifies the configuration to restore container images
	Type is the type of source for ClusterRestore
	GlobalConfig is the global restore configuration which is applicable for the components of restore unless explicitly overridden at the component level
	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
	Encryption specify encryption key to decrypt the encrypted data.
	ImageRegistry specifies the configuration to restore container images
	Type is the type of source for ClusterRestore
	GlobalConfig is the global restore configuration which is applicable for the components of restore unless explicitly overridden at the component level
	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
	Encryption specify encryption key to decrypt the encrypted data.
	ImageRegistry specifies the configuration to restore container images
	Type is the type of source for ClusterRestore
	GlobalConfig is the global restore configuration which is applicable for the components of restore unless explicitly overridden at the component level
	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
	Encryption specify encryption key to decrypt the encrypted data.
	ImageRegistry specifies the configuration to restore container images

ClusterRestoreCondition

(Appears on: ClusterRestoreStatus)

Field	Description
	Phase defines the current phase of the controller.
	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 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.
	ConsistentSet is a reference to the ConsistentSet where restore is performed if type is ConsistentSet.

ClusterRestoreSourceType (string alias)

(Appears on: ClusterRestoreSource)

ClusterRestoreSpec

(Appears on: ClusterRestore)

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

Field	Description
	Type is the type of source for ClusterRestore
	GlobalConfig is the global restore configuration which is applicable for the components of restore unless explicitly overridden at the component level
	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
	Encryption specify encryption key to decrypt the encrypted data.
	ImageRegistry specifies the configuration to restore container images

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 is the current phase of the ClusterRestore operation.
	PhaseStatus is the status of phase ClusterRestore operation going through.
	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 is the overall condition of cluster restore resource.
	Duration is the amount of time the ClusterRestore process took to finish.
	ComponentInfos contains information related to each individual backup to be restored
createdNamespaces []string	CreatedNamespaces are the namespaces created for restores.
	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.
encryptionEnabled bool	EncryptionEnabled flag shows that encryption is enabled for cluster backup

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
	LatestClusterRestore is the reference to Latest ClusterRestore in any state, 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

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.
	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 specifies the resources already existing in cluster defined in application.
	SkippedResources specifies the resources skipped while restoring.
	FailedResources specifies the resources for which the restore operation failed
	NewResourcesAdded specifies the resources added(duplicated and modified) during restore.
	ExcludedResources specifies the resources excluded during restore
	FailedCleanupResources specified the resources which doesn’t get clean up in failed restore
	TransformStatus is the status of transformation performed
	Phase is the current phase of the application component while restore.
	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, SnapshotInfo)

Field	Description
	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 defines the current phase of the data components.

ConsistentSet

nolint:lll // directive continuation ConsistentSet is the Schema for the ConsistentSet API

Field	Description
	Refer to the Kubernetes API documentation for the fields of the metadata field.
	ContinuousRestorePlan specifies the object references of continuousRestorePlan used
location string	Location is the target location where Backup/ClusterBackup is stored
	TransformComponents specifies the transformation configuration for PVCs both in custom and helm charts
	ContinuousRestorePlan specifies the object references of continuousRestorePlan used
location string	Location is the target location where Backup/ClusterBackup is stored
	TransformComponents specifies the transformation configuration for PVCs both in custom and helm charts
	ContinuousRestorePlan specifies the object references of continuousRestorePlan used
location string	Location is the target location where Backup/ClusterBackup is stored
	TransformComponents specifies the transformation configuration for PVCs both in custom and helm charts
	ContinuousRestorePlan specifies the object references of continuousRestorePlan used
location string	Location is the target location where Backup/ClusterBackup is stored
	TransformComponents specifies the transformation configuration for PVCs both in custom and helm charts

ConsistentSetCondition

(Appears on: ConsistentSetStatus)

Field	Description
	Phase defines the current phase of the controller.
	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.

ConsistentSetInfo

(Appears on: BackupStatus, ClusterBackupStatus, ContinuousRestorePlanStatus)

Field	Description
consistentSetName string	ConsistentSetName is the name of ConsistentSet created for ContinuousRestore corresponding to the Backup/ClusterBackup
consistentSetUID k8s.io/apimachinery/pkg/types.UID	ScanInstanceUID is the UID of the ConsistentSet created for ContinuousRestore corresponding to the Backup/ClusterBackup
	ConsistentSetStatus is the current Status of ConsistentSet.
	ConsistentSetCreationTimeStamp is the creation timestamp of ConsistentSet
	ConsistentSetCompletionTimeStamp is the completion timestamp of ConsistentSet
	TotalSize is the aggregate size of the data restored

ConsistentSetScope (string alias)

(Appears on: ConsistentSetStatus)

ConsistentSetScope indicates scope of Consistent i.e. [Namespace or Cluster] as per the location given

ConsistentSetSpec

(Appears on: ConsistentSet)

ConsistentSetSpec defines the desired state of ConsistentSet

Field	Description
	ContinuousRestorePlan specifies the object references of continuousRestorePlan used
location string	Location is the target location where Backup/ClusterBackup is stored
	TransformComponents specifies the transformation configuration for PVCs both in custom and helm charts

ConsistentSetStats

(Appears on: ConsistentSetStatus)

ConsistentSetStats defines the stats for a consistent set

Field	Description

ConsistentSetStatus

(Appears on: ConsistentSet)

ConsistentSetStatus defines the observed state of ConsistentSet

Field	Description
	Status defines the status of ConsistentSet. When consistentSet is used in any Restore/ClusterRestore, it’s status will be in InUse
	Scope defines scope of ConsistentSet i.e. Namespace or Cluster
	StartTimestamp is the time when ConsistentSet was started.
	CompletionTimestamp is the time when ConsistentSet operation finished.
	BackupInfo contains the information of data restored done for each Backup available on the location specified. It contains a mapping of Backup-uuid and related data restored info.
	Size is the aggregate size of the data restored back.
percentageCompletion byte	PercentageCompletion is the percentage of ConsistentSet operation completed.
	Phase is the current phase of the ConsistentSet operation.
	PhaseStatus is the status of phase ConsistentSet operation going through.
	Condition is the overall condition of ConsistentSet resource.
	Duration is the amount of time the ConsistentSet process took to finish.

ContainerHookStatus

(Appears on: PodHookStatus)

ContainerHookStatus defines hook execution status for a containers

Field	Description
containerName string	ContainerName is container in which hooks are executed.
	PreHookStatus defines status for pre hooks
	PostHookStatus defines status for post hooks

ContainerImage

(Appears on: ImageSnapshot)

Field	Description
ID string	ID is the image ID to uniquely identify the image
registry string	Registry of the container image
repository string	Repository of the container image
image string	Image is the name of the container image
backupImageFQDN string	BackupImageFQDN is the actual image name provided in resource spec at the time of backup
tag string	Tag is the image tag of the container image
newTag string	NewTag is populated when the Tag exists on the repo with a different sha in case of restore
sha string	Sha is the sha digest of the container image
	ImagePullSecrets defines imagePullSecrets and resource who used these imagePullSecrets
warnings []string	Warnings is the list of warnings captured during image backup or restore of an application

ContinuousRestoreConfig

(Appears on: PolicySpec)

Field	Description
consistentSets int	ConsistentSets is the number of ConsistentSets to be retained for each Backup

ContinuousRestoreConfigInfo

(Appears on: BackupPlanSpec, ClusterBackupPlanSpec)

ContinuousRestoreConfigInfo defines the Continuous Restore instances info which will be used for Continuous Restore operation

Field	Description
	ContinuousRestoreInstances defines the list of Continuous Restore instances which will perform the Continuous Restore operation

ContinuousRestoreInstance

(Appears on: ContinuousRestoreConfigInfo)

ContinuousRestoreInstance defines details of Continuous Restore for InstanceID specified

Field	Description
instanceID string	InstanceID is the unique Instance ID of the Continuous Restore Service to be used for Continuous Restore
	ContinuousRestorePolicy is the object reference to the Continuous Restore Policy to be used for Continuous Restore
	TransformComponents specifies the transformation configuration for PVCs both in custom and helm charts

ContinuousRestorePlan

ContinuousRestorePlan is the Schema for the ContinuousRestorePlan API

Field	Description
	Refer to the Kubernetes API documentation for the fields of the metadata field.
	ContinuousRestorePolicy specifies the object references of ContinuousRestore policy
	Target specifies the object references of target used
	TransformComponents specifies the transformation configuration for PVCs both in custom and helm charts
	ContinuousRestorePolicy specifies the object references of ContinuousRestore policy
	Target specifies the object references of target used
	TransformComponents specifies the transformation configuration for PVCs both in custom and helm charts
	ContinuousRestorePolicy specifies the object references of ContinuousRestore policy
	Target specifies the object references of target used
	TransformComponents specifies the transformation configuration for PVCs both in custom and helm charts
	ContinuousRestorePolicy specifies the object references of ContinuousRestore policy
	Target specifies the object references of target used
	TransformComponents specifies the transformation configuration for PVCs both in custom and helm charts

ContinuousRestorePlanCondition

(Appears on: ContinuousRestorePlanStatus)

ContinuousRestorePlanCondition specifies the current condition of a ContinuousRestorePlan resource.

Field	Description
	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 defines the current phase of the controller.

ContinuousRestorePlanSpec

(Appears on: ContinuousRestorePlan)

ContinuousRestorePlanSpec defines the desired state of ContinuousRestorePlan

Field	Description
	ContinuousRestorePolicy specifies the object references of ContinuousRestore policy
	Target specifies the object references of target used
	TransformComponents specifies the transformation configuration for PVCs both in custom and helm charts

ContinuousRestorePlanStatus

(Appears on: ContinuousRestorePlan)

ContinuousRestorePlanStatus defines the observed state of ContinuousRestorePlan

Field	Description
	Condition is the current condition of a ContinuousRestorePlan.
	Status defines the status of the ContinuousRestorePlan resource as per the status of target
	ConsistentSetInfo is the list of ConsistentSet related info for the number of ConsistentSet defined

ContinuousRestoreStatus

(Appears on: BackupPlanStatus, ClusterBackupPlanStatus)

ContinuousRestoreStatus specifies the details of Continuous Restore operation status of an instance

Field	Description
continuousRestoreEnabled bool	ContinuousRestoreEnabled denotes if the Continuous Restore service is actually enabled on the ContinuousRestore site
	ContinuousRestoreSiteStatus is the current Status of ContinuousRestore service Available/Unavailable. It is updated as per the heartbeat of ContinuousRestore service
	LastConsistentSetCreationTimestamp is the creation time stamp of the last ConsistentSet created for this BackupPlan/ClusterBackupPlan
	LastSuccessfulConsistentSetTimestamp is the completion timestamp of the last successful ScanSet created for this BackupPlan/ClusterBackupPlan
numAvailableConsistentSet int	NumAvailableConsistentSet is the number of available ConsistentSets for this BackupPlan/ClusterBackupPlan on ContinuousRestore site
continuousRestorePlan string	ContinuousRestorePlan denotes the name of ContinuousRestorePlan created for this BackupPlan/ClusterBackupPlan on the ContinuousRestore site

CronSpec

(Appears on: SchedulePolicy)

CronSpec defines the Schedule string and the cronjob reference. The Schedule string will only be visible to the user to be configured, the reference will be set by the controller Deprecated: Instead of using single cron string, schedule policy will use list of cron string

Field	Description
schedule string

Crons

(Appears on: PolicySpec)

Crons defines the list of Schedule string and the cronjob references. The list of Schedule string will only be visible to the user to be configured, and the references will be set by the controller

Field	Description
schedule []string

Custom

(Appears on: RestoreCustom, Snapshot)

Custom defines the snapshot of Custom defined application.

Field	Description
	Resources defines the Kubernetes resources found from Custom application.