Custom Resource Definition - Application
API reference for Trilio Application
Was this helpful?
5.0.X
API reference for Trilio Application
Was this helpful?
Packages:
Package v1 contains API Schema definitions for the triliocrds v1 API group trigger images
Resource Types:
(Appears on: , )
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
string alias)(Appears on: , , )
ApplicationType specifies type of a Backup of an application
Backup represents the capture of Kubernetes BackupPlan defined by user at a point in time
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 defines the namespace and their configurations for backup
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.
Name
string
BackupCondition specifies the current condition of a backup resource.
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 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.
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 contains the relevant information to uniquely identify a child Backup created from a ClusterBackup
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 is the Schema for the BackupPlan API
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 contains the 3 types of components, helm charts, operators and custom label-based resources
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 specifies the current condition of a backupPlan resource.
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.
skipImageBackup
bool
SkipImageBackup is flag to skip the container images backup
BackupPlanInfo defines the object reference and status of a backupPlan
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
string alias)BackupPlanSelector used in ClusterBackupPlan Status to identify how corresponding backupPlan is selected by, it could be by NamespaceSelector or by BackupComponent
BackupPlanSpec defines the desired state of 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 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 defines the stats for a BackupPlan
immutable
bool
Immutable specify whether a backup data is going to be immutable.
BackupPlanStatus defines the observed state of BackupPlan
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
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
string alias)BackupScheduleType specifies the type of schedule which triggered the backup
BackupSpec defines the desired state of Backup
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 specifies the stats of a Backup
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 defines the observed state of Backup
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 comprises of backup object references and count of backups with different statuses
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
string alias)BackupType defines the type backup instance of an BackupPlan
CleanupConfig is the configuration for the PolicyType: Cleanup
backupDays
int
BackupDays is the age of backups to be cleaned
ClusterBackup is the Schema for the ClusterBackup API
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 specifies the current condition of a clusterBackup resource.
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 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.
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 is the Schema for the ClusterBackupPlan API
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 specifies the current condition of a cluster backup plan resource.
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 defines the desired state of ClusterBackupPlan
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 defines the stats for a ClusterBackupPlan
immutable
bool
Immutable specify whether a backup data is going to be immutable
ClusterBackupPlanStatus defines the observed state of ClusterBackupPlan
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 contains the object references for incremental or full backup type schedule policy
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 defines the desired state of ClusterBackup
Type is the type of clusterBackup in the sequence of clusterBackups.
ClusterBackupPlan is a reference to the ClusterBackupPlan to be backed up.
ClusterBackupStats specifies the stats of a ClusterBackup
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 defines the observed state of ClusterBackup
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 comprises of ClusterBackup object references and count of ClusterBackups with different statuses
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 defines the desired state of ClusterRestore
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
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.
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.
string alias)ClusterRestoreSpec defines the source from where the ClusterRestore is to be done
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 defines the stats for a RestorCluster
ClusterBackupPlan is the reference to ClusterBackupPlan associated with ClusterRestore
ClusterBackup is the reference to the ClusterBackup associated with ClusterRestore
ClusterRestoreStatus defines the observed state of ClusterRestore
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 comprises of ClusterRestore object references and count of ClusterRestore with different statuses
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
backupNamespace
string
restoreNamespace
string
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.
string alias)ComponentScope indicates scope of components i.e. [App or Namespace] present in backup or restore
ComponentStatus defines the details of restore of application component.
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.
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.
nolint:lll // directive continuation ConsistentSet is the Schema for the ConsistentSet API
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
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.
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
string alias)ConsistentSetScope indicates scope of Consistent i.e. [Namespace or Cluster] as per the location given
ConsistentSetSpec defines the desired state of ConsistentSet
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 defines the stats for a consistent set
ConsistentSetStatus defines the observed state of ConsistentSet
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 defines hook execution status for a containers
containerName
string
ContainerName is container in which hooks are executed.
PreHookStatus defines status for pre hooks
PostHookStatus defines status for post hooks
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
consistentSets
int
ConsistentSets is the number of ConsistentSets to be retained for each Backup
ContinuousRestoreConfigInfo defines the Continuous Restore instances info which will be used for Continuous Restore operation
ContinuousRestoreInstances defines the list of Continuous Restore instances which will perform the Continuous Restore operation
ContinuousRestoreInstance defines details of Continuous Restore for InstanceID specified
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 is the Schema for the ContinuousRestorePlan API
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 specifies the current condition of a ContinuousRestorePlan resource.
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 defines the desired state of ContinuousRestorePlan
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 defines the observed state of ContinuousRestorePlan
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 specifies the details of Continuous Restore operation status of an instance
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 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
schedule
string
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
schedule
[]string
Custom defines the snapshot of Custom defined application.
Resources defines the Kubernetes resources found from Custom application.
DataSnapshot specifies the Snapshot of the Volumes resources in the Custom defined application.
warnings
[]string
Warnings is the list of warnings captured during backup or restore of an application
CustomSelector defines custom resource selection using SelectResources which defines include resources & ExcludeResourcesspecify resource exclusion based on Label based & GVK based selection
SelectResources specify resource selection based on LabelSelector & GVKSelector
ExcludeResources specify resource exclusion based on LabelSelector & GVKSelector
CustomTransform specifies transformation configuration for Custom label-based resources
transformName
string
TransformName specifies the name of transformation
Resources specifies the resources for which transformation needs to be applied
JSONPatches specifies the JSON patches to be applied
DataSnapshot defines Snapshot of a Persistent Volume
BackupType is the type of Volume backup in the sequence of backups.
location
string
Location is the absolute path of qcow2 image of a volume in the target.
persistentVolumeName
string
PersistentVolumeName is the name of PersistentVolume which is bound to PersistentVolumeClaim
persistentVolumeMetadata
string
PersistentVolumeMetadata is the metadata of PersistentVolume which is bound to PersistentVolumeClaim.
persistentVolumeClaimName
string
PersistentVolumeClaimName is the name of PersistentVolumeClaim which is bound to Volume.
persistentVolumeClaimMetadata
string
PersistentVolumeClaimMetadata is the metadata of PersistentVolumeClaim which is bound to Volume(Deprecated).
operatorResourceVolume
bool
OperatorResourceVolume will be true for the PVC created by the operator resource.
VolumeSnapshot specifies the CSI snapshot of a Persistent Volume.
PVSize is the actual size of the persistent volume for which backup is happening.
SnapshotSize is the size of the volume snapshot of a Persistent Volume.
Size is the size of qcow2 created/restored in backup/restore.
uploaded
bool
Uploaded is to imply whether volume snapshot taken is uploaded to target.
error
string
Error is the error occurred while backing up data component if any.
PodContainersMap is the set of Pod-Containers which share Persistent Volume.
Conditions are the current statuses for backup and restore PVCs.
string alias)Encryption defines encryption secret to encrypt/decrypt backup data on target
EncryptionSecret is object ref of a secret which contains encryption key for backup encryption
GVKR defines the Kubernetes resource type and name
GroupVersionKind specifies GVK uniquely representing particular resource type.
resource
string
Resource specifies resource name
GroupVersionKind defines the Kubernetes resource type
group
string
version
string
kind
string
Helm defines the snapshot of application defined by a Helm.
release
string
Release string is the name of release
newRelease
string
NewRelease string is the new release name which will get used while validation and restore process
revision
int32
Revision defines the version of deployed release backed up
Deprecated: Resource is the captured GVK (secret or configmap) and corresponding object names slice.
Resources are the helm release resources with their GVK and Name
StorageBackend is the enum which can be either configmaps and secrets
Version represents the Helm binary version used at the time of snapshot
DataSnapshot specifies the Snapshot of the Volumes defined in the helm chart resources.
warnings
[]string
Warnings is the list of warnings captured during backup or restore of an application
string alias)HelmStorageBackend defines the enum for the types of storage backend from where the helm release is backed-up
HelmTransform specifies transformation configuration for Helm
transformName
string
TransformName specifies the name of transformation
release
string
Release specifies the release name for which the transformation is to be done
Set specifies the key-value pair to be set
string alias)HelmVersion defines the version of helm binary used while backup; currently supported version is v3
Hook is the Schema for the hooks API.
Refer to the Kubernetes API documentation for the fields of the metadata field.
PreHook is the Hook executed to quiesce the application before backup operation
PostHook is the Hook executed to unquiesce the application after backup operation
PreHook is the Hook executed to quiesce the application before backup operation
PostHook is the Hook executed to unquiesce the application after backup operation
PreHook is the Hook executed to quiesce the application before backup operation
PostHook is the Hook executed to unquiesce the application after backup operation
PreHook is the Hook executed to quiesce the application before backup operation
PostHook is the Hook executed to unquiesce the application after backup operation
HookComponentStatus indicates status of hook execution for backup/restore
podReadyWaitSeconds
uint16
PodReadyWaitSeconds is the wait time for which hook execution waits before performing hook Quiescing/UnQuiescing It is only applicable for pods which are found in NotRunning state during hook execution Default value is 120s, that will be set by webhook.
HookPriorityStatuses specifies pre/post hook execution status for current backup.
HookConfig defines the sequence of hook actions and their associated pod-container regexes
Mode can be sequential or parallel which defines the way hooks will be executed. If mode is parallel, ignore the hook sequence.
podReadyWaitSeconds
uint16
PodReadyWaitSeconds is the wait time for which hook execution waits before performing hook Quiescing/UnQuiescing It is only applicable for pods which are found in NotRunning state during hook execution Default value is 120s, that will be set by webhook.
Hooks defines the config’s for hook action object reference to the matching regexes of pod and containers
HookConfiguration contain’s configuration for hook implementation.
maxRetryCount
byte
MaxRetryCount is the maximum number of times pre/post hook execution can be retried. MaxRetryCount will be equal to the RetryCount specified in Hook Spec.
timeoutSeconds
uint16
TimeoutSeconds is A Maximum allowed time in seconds to execute Hook. timeout here is a hard timeout. Meaning the command needs to exit in that time, either with exit code 0 or non 0. hook execution will be considered in error if it fails to complete within timeout.
ignoreFailure
bool
IgnoreFailure is a boolean, if set to true all the failures will be ignored for both in pre and post hooks Default is false.
HookExecution specifies the Hook required to quiesce or unquiesce the application
ExecAction is a Command to be executed as a part of Hook. Specifies the action to take. Commands should include what shell to use or the commands and its args which will be able to run without the shell. User can provide multiple commands merged as a part of a single command in the ExecAction. Shell Script Ex. [“/bin/bash”, “-c”, “echo hello > hello.txt && echo goodbye > goodbye.txt”]
ignoreFailure
bool
IgnoreFailure is a boolean, if set to true all the failures will be ignored both in pre and post hooks Default is false.
maxRetryCount
byte
MaxRetryCount count will be used to retry hook execution within the time range specified by Timeout in TimeoutSeconds field. Hook execution will be considered in error if it fails to complete within MaxRetryCount. Each retry count will be run with timeout of TimeoutSeconds field. Default is 0
timeoutSeconds
uint16
TimeoutSeconds is A Maximum allowed time in seconds for each retry count according to value set inMaxRetryCount field to execute Hook. timeout here is a hard timeout. MaxRetryCount field is related to TimeoutSeconds, Meaning each retry count will run with a timeout of TimeoutSeconds. The command needs to exit in that time, either with exit code 0 or non 0.
HookInfo defines the config for hook action object reference to the matching regexes of pod and containers
Hook is the object reference of the Hook resource which will be run while quiescing
PodSelector will identify set of pods for hook config based on either Labels or Regex pattern.
containerRegex
string
ContainerRegex identifies containers for hook execution from pods which are filtered using PodSelector. If not given then hooks will be executed in all the containers of the identified pods
HookPriority contain hook & their targeted resources
Hook is the object reference of the Hook resource which will be run while quiescing
PreHookConf defines how pre hook implementation will be handled
PostHookConf defines how post hook implementation will be handled
HookTarget defines targeting hook resources.
HookPriorityStatus defines observed state for hooks priority wise.
priority
byte
Priority defines priority for hooks. backup controller will use Priority to determine sequence of hook execution. In case of parallel Mode, priority will be same for all, in case of sequential Mode, priority will be same for a group and not individual HookConfig Set. Default Priority is 0.
Hooks defines list of hooks with priority Priority.
HookSpec defines the desired state of Hook.
PreHook is the Hook executed to quiesce the application before backup operation
PostHook is the Hook executed to unquiesce the application after backup operation
HookStatus defines the observed state of Hook.
Owner specifies the parent for identified pods in PodHookStatus. backup controller will fetch pods from Owner to execute the hooks. Owner will be nil for pods with no owner.
containerRegex
string
ContainerRegex identifies containers in identified pods to execute hooks.
PodHookStatus specifies pre/post hook execution status for current backup.
ImageSnapshot specifies the Snapshot of the container images in the backup.
ImagePullSecret defines imagePullSecrets and resource who used these imagePullSecrets
ReferencedBy defines GVK and name of resource who is using these imagePullSecrets
ImagePullSecret is the pull secret to pull the container image
repository
string
Repository is a container repository to restore the backup container images
registry
string
Registry is container registry to restore the backup container images
RegistryAuthSecret contains the docker config auth file or username and password, which will authenticate the docker push
ImageSnapshot defines the snapshot of images defined by all applications.
BackupType is the type of image backup in the sequence of backups.
location
string
Location is the absolute path of image qcow2 in the target.
Size is the size of qcow2 created/restored in backup/restore.
error
string
Error is the error occurred while backing up image component if any.
ContainerImages specifies the list of container images to use in the backup
KeyValue specifies key-value pair for helm transformation
key
string
Key denotes the key for which value is to be set
value
string
Value denotes the value to be set
License is the Schema for the licenses API
Refer to the Kubernetes API documentation for the fields of the metadata field.
key
string
Key is the product key to use triliovault application to perform backup/restore.
key
string
Key is the product key to use triliovault application to perform backup/restore.
key
string
Key is the product key to use triliovault application to perform backup/restore.
key
string
Key is the product key to use triliovault application to perform backup/restore.
LicenseCondition specifies the current condition of a license.
Status is the status of the condition.
Timestamp is the time a condition occurred.
message
string
A brief message indicating details about why the component is in this condition.
Phase defines the current phase of the controller.
string alias)LicenseEdition specifies the edition of the license.
LicenseProperties specifies the properties of a license based on provided license key.
company
string
Company is the name of a company purchased license for.
Edition is the type of license purchased to use triliovault application.
CreationTimestamp is the time license created to use triliovault application.
PurchaseTimestamp is the time user purchased the license to use triliovault application.
ExpirationTimestamp is the time provided license going to expire and won’t be able to perform backup/restore operation.
MaintenanceExpiryTimestamp is the time maintenance support for the provided license going to expire.
kubeUID
string
KubeUID is the kubesystem or namespace uuid of the cluster the license purchased for.
Scope is the scope of a KubeUID the license purchased for.
version
string
Version is the version of a license.
sen
string
SEN is the unique serial of a license purchased.
numberOfUsers
int
NumberOfUsers is the total number of users the license valid for.
serverID
string
ServerID is the unique serverID of license purchased.
licenseID
string
LicenseID is the identifier for the license.
capacity
uint32
Capacity is the maximum capacity to use the license in number of CPUs.
active
bool
Active is the status of the license.
LicenseSpec defines the desired state of License
key
string
Key is the product key to use triliovault application to perform backup/restore.
string alias)LicenseState specifies the overall status of the license.
LicenseStatus defines the observed state of License
Status is the overall status of the license based on provided key.
message
string
A brief message indicating details about why the license in this state.
Properties is the details about the license based on provided license key.
Condition is the current condition of a license.
currentNodeCount
uint32
Deprecated: CurrentNodeCount is the total number of nodes kubernetes cluster comprised of where each node capped at 2 vCPUs/pCPUs.
currentCPUCount
uint32
CurrentCPUCount is the total number of CPUs currently available.
GracePeriodStartTimestamp is the time grace period started to use triliovault application.
GracePeriodEndTimestamp is the time grace period for using the triliovault application going to end.
maxNodes
uint32
Deprecated: MaxNodes is the count of maximum number of nodes available in cluster.
maxCPUs
uint32
MaxCPUs is the count of maximum number of CPUs available in cluster.
string alias)Mode is the enum for 2 modes of quiescing the application components i.e Sequential or Parallel
string alias)MultiNamespaceCondition specifies the current condition of a clusterNamespace resource.
Status is the status of the condition.
Timestamp is the time a condition occurred.
reason
string
A brief message indicating details about why clusterNamespace resource is in this condition.
NFSCredentials defines the credentials to use NFS as a target type.
nfsExport
string
A NFS location in format trilio.net:/data/location/abcde or 192.156.13.1:/user/keeth/data.
nfsOptions
string
An additional options passed to mount NFS directory e.g. rw, suid, hard, intr, timeo, retry.
NamespaceSelector defines namespaces for which backups are to be taken based on NamespaceSelector(labels & match expression) & their configurations
name
string
Name specify name for NamespaceSelector, useful to identify why namespaces grouped together using LabelSelector
LabelSelector identifies set of namespaces for which backup are to be taken based on labels & match expression
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.
ObjectStoreCredentials defines the credentials to use Object Store as a target type.
url
string
URL to connect the Object Store.
accessKey
string
AccessKey is to authenticate access to Object Store. Deprecated: after addition of secret object ref
secretKey
string
SecretKey is to authenticate access to Object Store. Deprecated: after addition of secret object ref
CredentialSecret is object ref of a secret which contains target credentials like accessKey, secretKey, etc.
bucketName
string
BucketName is the name of a bucket within Object Store.
region
string
Region where the Object Store resides.
objectLockingEnabled
bool
ObjectLockingEnabled specify if target is set to be immutable
skipCertVerification
bool
SkipCertVerification specify if target needs to be accessed without certificate verification and usage.
string alias)Op indicates the Json Patch operations
string alias)OperationType specifies the type of operation for Job
Operator defines the snapshot of application defined by an Operator.
operatorId
string
OperatorId is unique ID for a particular operator
CustomResources is the list of all custom resource’s GVK and names list
Helm represents the snapshot of the helm chart for helm based operator
OperatorResources defines the a kubernetes resources found from Operator resources.
ApplicationResources defines the kubernetes resources found from operator Custom Resources.
DataSnapshot specifies the Snapshot of the Volumes defined in the operator resources.
warnings
[]string
Warnings is the list of warnings captured during backup or restore of an application
OperatorSelector defines the mapping of operator name and their selectors
operatorId
string
OperatorId is any unique ID for a particular operator
CustomResources list resources where each resource contains custom resource gvk and metadata
helmRelease
string
HelmRelease is the release name of the helm based operator
olmSubscription
string
OLMSubscription is the subscription name for the olm based operator
Deprecated: OperatorResourceSelector is the selector for operator resources
OperatorResources specify operator resource selection based on LabelSelector & GVKSelector
Deprecated: ApplicationResourceSelector is the selector for instances deployed by the operator resources
ApplicationResources specify resource selection for instances deployed by the operator resources based on LabelSelector & GVKSelector.
ExcludeResources specify operator resources to exclude from backup based on LabelSelector & GVKSelector
GroupVersionKind specifies GVK uniquely representing particular owner type.
name
string
Name is name of owner
Op specifies the operation to perform, can be test/add/remove/replace/copy/move
from
string
From specifies the source element path. This field is mandatory for copy/move operation
path
string
Path specifies the destination element path which needs to be transformed
value
Kubernetes apiextensions/v1.JSON
Values specifies the value for any operation. This field is mandatory for test/add/replace operation
PodContainers defines Pod and containers running in that Pod.
podName
string
PodName is the name of pod which will be the key for the map between pod containers list
containers
[]string
Containers is the list of containers inside a pod
PodHookStatus defines observed state for hooks
podName
string
PodName is the single pod name from identified sets of pods filtered for hook config.
ContainerHookStatus defines status for filtered containers in a pod named ‘PodName’ One Container can have multiple hook executions.
PodSelector selects pods for hook execution based on either Labels or Regex pattern. Both Labels & Regex can also specify
regex
string
Policy is the Schema for the policies API
Refer to the Kubernetes API documentation for the fields of the metadata field.
Type is a field of Policy spec, which defines the policy type containing only 3 values: Retention, Timeout, Cleanup.
default
bool
Default field states if the current type of policy is default across the TV application
RetentionConfig field defines the configuration for Retention policy
TimeoutConfig field defines the configuration for timeout policy
CleanupConfig field defines the configuration for Cleanup policy
ScheduleConfig field defines the configuration for Schedule policy
SecurityScanConfig field defines the configuration for SecurityScan policy
ContinuousRestoreConfig field defines the configuration for ContinuousRestore policy
Type is a field of Policy spec, which defines the policy type containing only 3 values: Retention, Timeout, Cleanup.
default
bool
Default field states if the current type of policy is default across the TV application
RetentionConfig field defines the configuration for Retention policy
TimeoutConfig field defines the configuration for timeout policy
CleanupConfig field defines the configuration for Cleanup policy
ScheduleConfig field defines the configuration for Schedule policy
SecurityScanConfig field defines the configuration for SecurityScan policy
ContinuousRestoreConfig field defines the configuration for ContinuousRestore policy
Type is a field of Policy spec, which defines the policy type containing only 3 values: Retention, Timeout, Cleanup.
default
bool
Default field states if the current type of policy is default across the TV application
RetentionConfig field defines the configuration for Retention policy
TimeoutConfig field defines the configuration for timeout policy
CleanupConfig field defines the configuration for Cleanup policy
ScheduleConfig field defines the configuration for Schedule policy
SecurityScanConfig field defines the configuration for SecurityScan policy
ContinuousRestoreConfig field defines the configuration for ContinuousRestore policy
Type is a field of Policy spec, which defines the policy type containing only 3 values: Retention, Timeout, Cleanup.
default
bool
Default field states if the current type of policy is default across the TV application
RetentionConfig field defines the configuration for Retention policy
TimeoutConfig field defines the configuration for timeout policy
CleanupConfig field defines the configuration for Cleanup policy
ScheduleConfig field defines the configuration for Schedule policy
SecurityScanConfig field defines the configuration for SecurityScan policy
ContinuousRestoreConfig field defines the configuration for ContinuousRestore policy
PolicySpec defines the desired state of Policy
Type is a field of Policy spec, which defines the policy type containing only 3 values: Retention, Timeout, Cleanup.
default
bool
Default field states if the current type of policy is default across the TV application
RetentionConfig field defines the configuration for Retention policy
TimeoutConfig field defines the configuration for timeout policy
CleanupConfig field defines the configuration for Cleanup policy
ScheduleConfig field defines the configuration for Schedule policy
SecurityScanConfig field defines the configuration for SecurityScan policy
ContinuousRestoreConfig field defines the configuration for ContinuousRestore policy
PolicyStatus defines the observed state of Policy
string alias)PolicyType is the Enum for types of policies
PrePostHookStatus defines Pre and Post hook execution status.
Status is the status for pre/post hook execution
exitStatus
string
ExitStatus contains returned exit code and error trace after pre/post hook execution
retryCount
byte
RetryCount count used to retry hook execution within the time range specified by Timeout. This is the actual number of times backup controller retried for pre/post hook execution if MaxRetryCount>0. Default is 0
Report specifies counts of different level of Vulnerabilities
low
int
medium
int
high
int
critical
int
total
int
Resource defines the list of names of a Kubernetes resource of a particular GVK.
GroupVersionKind specifies GVK uniquely representing particular resource type.
objects
[]string
Objects is the list of names of all the objects of the captured GVK
ResourceSelector used to define include/exclude resources as well as other resource selection, resource selection can be done using LabelSelector(MatchLabels & MatchExpression) & GVKSelector(GVK based & object names).
LabelSelector specifies resource selection using labels & match expression
GVKSelector specify resource selection using GVK & object name based selection Default ignore list won’t be considered for these resources and will always be backed up whatever is specified
Restore is the Schema for the restores API
Refer to the Kubernetes API documentation for the fields of the metadata field.
Source defines the source referred for performing restore operation
restoreNamespace
string
Namespace is a name of namespace in cluster where backed resources will be restored Deprecated: Restore will be allowed only in Restore CR Namespace so RestoreNamespace is redundant.
skipIfAlreadyExists
bool
SkipIfAlreadyExists specifies whether to skip restore of a resource if already exists in the namespace restored. Deprecated: SkipIfAlreadyExists flag is now moved under RestoreFlags struct
patchIfAlreadyExists
bool
PatchIfAlreadyExists specifies whether to patch spec of a already exists resource in the namespace restored. Deprecated: PatchIfAlreadyExists flag is now moved under RestoreFlags struct
patchCRD
bool
PatchCRD specifies whether to patch spec of a already exists crd. Deprecated: PatchCRD flag is now moved under RestoreFlags struct
omitMetadata
bool
OmitMetadata specifies whether to omit metadata like labels, annotations of resources while restoring them. Deprecated: OmitMetadata flag is now moved under RestoreFlags struct
skipOperatorResources
bool
SkipOperatorResources specifies whether to skip operator resources or not at the time of restore. (for the use case when operator is already present and the application of that operator needs to be restored) Deprecated: SkipOperatorResources flag is now moved under RestoreFlags struct
disableIgnoreResources
bool
DisableIgnoreResources is responsible for the behavior of default list of resources being ignored at the restore. If set to true, those resources will not be ignored Deprecated: DisableIgnoreResources flag is now moved under RestoreFlags struct
Env is the List of environment variables to set in the container. Cannot be updated.
TransformComponents specifies the component-wise transformation configuration
ExcludeResources specifies the resources to be excluded from backup while restoring
HookConfig specifies the Post Restore Hooks Executed in reverse sequence of the sequence specified here
cleanupOnFailure
bool
CleanupOnFailure is flag to perform cleanup after restore fails. Defaults to false Deprecated: CleanupOnFailure flag is now moved under ActionFlags struct
protectRestoredApp
bool
ProtectRestoredApp decides if T4K will setup a backupplan to protect the restored application. Deprecated: ProtectRestoredApp flag is now moved under ActionFlags struct
Encryption specify encryption key to decrypt the encrypted data.
resourcesReadyWaitSeconds
uint16
ResourcesReadyWaitSeconds is the wait time for restored application’s pods to come up. If user application is having webhook then CR creation will fail is webhook is not up. Provide the wait time in such case.
ImageRegistry specifies the configuration to restore container images.
Source defines the source referred for performing restore operation
restoreNamespace
string
Namespace is a name of namespace in cluster where backed resources will be restored Deprecated: Restore will be allowed only in Restore CR Namespace so RestoreNamespace is redundant.
skipIfAlreadyExists
bool
SkipIfAlreadyExists specifies whether to skip restore of a resource if already exists in the namespace restored. Deprecated: SkipIfAlreadyExists flag is now moved under RestoreFlags struct
patchIfAlreadyExists
bool
PatchIfAlreadyExists specifies whether to patch spec of a already exists resource in the namespace restored. Deprecated: PatchIfAlreadyExists flag is now moved under RestoreFlags struct
patchCRD
bool
PatchCRD specifies whether to patch spec of a already exists crd. Deprecated: PatchCRD flag is now moved under RestoreFlags struct
omitMetadata
bool
OmitMetadata specifies whether to omit metadata like labels, annotations of resources while restoring them. Deprecated: OmitMetadata flag is now moved under RestoreFlags struct
skipOperatorResources
bool
SkipOperatorResources specifies whether to skip operator resources or not at the time of restore. (for the use case when operator is already present and the application of that operator needs to be restored) Deprecated: SkipOperatorResources flag is now moved under RestoreFlags struct
disableIgnoreResources
bool
DisableIgnoreResources is responsible for the behavior of default list of resources being ignored at the restore. If set to true, those resources will not be ignored Deprecated: DisableIgnoreResources flag is now moved under RestoreFlags struct
Env is the List of environment variables to set in the container. Cannot be updated.
TransformComponents specifies the component-wise transformation configuration
ExcludeResources specifies the resources to be excluded from backup while restoring
HookConfig specifies the Post Restore Hooks Executed in reverse sequence of the sequence specified here
cleanupOnFailure
bool
CleanupOnFailure is flag to perform cleanup after restore fails. Defaults to false Deprecated: CleanupOnFailure flag is now moved under ActionFlags struct
protectRestoredApp
bool
ProtectRestoredApp decides if T4K will setup a backupplan to protect the restored application. Deprecated: ProtectRestoredApp flag is now moved under ActionFlags struct
Encryption specify encryption key to decrypt the encrypted data.
resourcesReadyWaitSeconds
uint16
ResourcesReadyWaitSeconds is the wait time for restored application’s pods to come up. If user application is having webhook then CR creation will fail is webhook is not up. Provide the wait time in such case.
ImageRegistry specifies the configuration to restore container images.
Source defines the source referred for performing restore operation
restoreNamespace
string
Namespace is a name of namespace in cluster where backed resources will be restored Deprecated: Restore will be allowed only in Restore CR Namespace so RestoreNamespace is redundant.
skipIfAlreadyExists
bool
SkipIfAlreadyExists specifies whether to skip restore of a resource if already exists in the namespace restored. Deprecated: SkipIfAlreadyExists flag is now moved under RestoreFlags struct
patchIfAlreadyExists
bool
PatchIfAlreadyExists specifies whether to patch spec of a already exists resource in the namespace restored. Deprecated: PatchIfAlreadyExists flag is now moved under RestoreFlags struct
patchCRD
bool
PatchCRD specifies whether to patch spec of a already exists crd. Deprecated: PatchCRD flag is now moved under RestoreFlags struct
omitMetadata
bool
OmitMetadata specifies whether to omit metadata like labels, annotations of resources while restoring them. Deprecated: OmitMetadata flag is now moved under RestoreFlags struct
skipOperatorResources
bool
SkipOperatorResources specifies whether to skip operator resources or not at the time of restore. (for the use case when operator is already present and the application of that operator needs to be restored) Deprecated: SkipOperatorResources flag is now moved under RestoreFlags struct
disableIgnoreResources
bool
DisableIgnoreResources is responsible for the behavior of default list of resources being ignored at the restore. If set to true, those resources will not be ignored Deprecated: DisableIgnoreResources flag is now moved under RestoreFlags struct
Env is the List of environment variables to set in the container. Cannot be updated.
TransformComponents specifies the component-wise transformation configuration
ExcludeResources specifies the resources to be excluded from backup while restoring
HookConfig specifies the Post Restore Hooks Executed in reverse sequence of the sequence specified here
cleanupOnFailure
bool
CleanupOnFailure is flag to perform cleanup after restore fails. Defaults to false Deprecated: CleanupOnFailure flag is now moved under ActionFlags struct
protectRestoredApp
bool
ProtectRestoredApp decides if T4K will setup a backupplan to protect the restored application. Deprecated: ProtectRestoredApp flag is now moved under ActionFlags struct
Encryption specify encryption key to decrypt the encrypted data.
resourcesReadyWaitSeconds
uint16
ResourcesReadyWaitSeconds is the wait time for restored application’s pods to come up. If user application is having webhook then CR creation will fail is webhook is not up. Provide the wait time in such case.
ImageRegistry specifies the configuration to restore container images.
Source defines the source referred for performing restore operation
restoreNamespace
string
Namespace is a name of namespace in cluster where backed resources will be restored Deprecated: Restore will be allowed only in Restore CR Namespace so RestoreNamespace is redundant.
skipIfAlreadyExists
bool
SkipIfAlreadyExists specifies whether to skip restore of a resource if already exists in the namespace restored. Deprecated: SkipIfAlreadyExists flag is now moved under RestoreFlags struct
patchIfAlreadyExists
bool
PatchIfAlreadyExists specifies whether to patch spec of a already exists resource in the namespace restored. Deprecated: PatchIfAlreadyExists flag is now moved under RestoreFlags struct
patchCRD
bool
PatchCRD specifies whether to patch spec of a already exists crd. Deprecated: PatchCRD flag is now moved under RestoreFlags struct
omitMetadata
bool
OmitMetadata specifies whether to omit metadata like labels, annotations of resources while restoring them. Deprecated: OmitMetadata flag is now moved under RestoreFlags struct
skipOperatorResources
bool
SkipOperatorResources specifies whether to skip operator resources or not at the time of restore. (for the use case when operator is already present and the application of that operator needs to be restored) Deprecated: SkipOperatorResources flag is now moved under RestoreFlags struct
disableIgnoreResources
bool
DisableIgnoreResources is responsible for the behavior of default list of resources being ignored at the restore. If set to true, those resources will not be ignored Deprecated: DisableIgnoreResources flag is now moved under RestoreFlags struct
Env is the List of environment variables to set in the container. Cannot be updated.
TransformComponents specifies the component-wise transformation configuration
ExcludeResources specifies the resources to be excluded from backup while restoring
HookConfig specifies the Post Restore Hooks Executed in reverse sequence of the sequence specified here
cleanupOnFailure
bool
CleanupOnFailure is flag to perform cleanup after restore fails. Defaults to false Deprecated: CleanupOnFailure flag is now moved under ActionFlags struct
protectRestoredApp
bool
ProtectRestoredApp decides if T4K will setup a backupplan to protect the restored application. Deprecated: ProtectRestoredApp flag is now moved under ActionFlags struct
Encryption specify encryption key to decrypt the encrypted data.
resourcesReadyWaitSeconds
uint16
ResourcesReadyWaitSeconds is the wait time for restored application’s pods to come up. If user application is having webhook then CR creation will fail is webhook is not up. Provide the wait time in such case.
ImageRegistry specifies the configuration to restore container images.
RestoreApplication defines the snapshot contents of an Application Backup.
HelmCharts specifies the backed up helm resources restored as Helm Charts.
Operators specifies the backed up operator resources restored as Operators.
Custom specifies the backup up kubernetes resources.
Image specifies the backed up container images to be restored
RestoreCondition specifies the current condition of a restore resource.
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.
resourcesReadyWaitSeconds
uint16
ResourcesReadyWaitSeconds is the wait time for restored application’s pods to come up. If user application is having webhook then CR creation will fail is webhook is not up. Provide the wait time in such case.
RestoreCustom defines the backed up kubernetes resources.
Snapshot defines the snapshot of custom application to be restored.
Status specifies the details of component restore in a namespace
useOCPNamespaceUIDRange
bool
UseOCPNamespaceUIDRange specifies whether to restore the original uid or use the SCC UID range defined on OCP namespaces on the application data.
skipIfAlreadyExists
bool
SkipIfAlreadyExists specifies whether to skip restore of a resource if already exists in the namespace restored.
patchIfAlreadyExists
bool
PatchIfAlreadyExists specifies whether to patch spec of a already exists resource in the namespace restored.
patchCRD
bool
PatchCRD specifies whether to patch spec of a already exists crd.
omitMetadata
bool
OmitMetadata specifies whether to omit metadata like labels, annotations of resources while restoring them.
skipOperatorResources
bool
SkipOperatorResources specifies whether to skip operator resources or not at the time of restore. (for the use case when operator is already present and the application of that operator needs to be restored)
disableIgnoreResources
bool
DisableIgnoreResources is responsible for the behavior of default list of resources being ignored at the restore. If set to true, those resources will not be ignored
onlyData
bool
OnlyData flag decides if the restore operation will only restore data components.
onlyMetadata
bool
OnlyMetadata flag decides if the restore operation will only restore metadata components.
overrideImageIfExist
bool
OverrideImageIfExist overrides existing image from the backup image if it is already present.
RestoreHelm defines the backed up helm application to be restored.
Snapshot defines the snapshot of application to be restored by a Helm.
Status specifies the details of component restore in a namespace
RestoreImage defines the backup container images to be restored.
ImageSnapshot are the images which are restored from the backup.
RestoreOperator defines the backed up operator application to be restored.
Snapshot defines the snapshot of application to be restored by a Operator.
Status specifies the details of component restore in a namespace
string alias)nolint:lll // too long line RestorePhase specifies the one of phase of Restore operation
RestoreSource defines the source from where the restore is to be done
Type is the type of source for restore
Backup is a reference to the Backup instance restored if type is Backup.
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.
BackupPlan is a reference to the BackupPlan whose latest successful backup is to be restored.
ConsistentSet is a reference to the ConsistentSet where restore is performed if type is ConsistentSet.
string alias)RestoreSourceType defines the type of source for restore
RestoreSpec defines the desired state of Restore
Source defines the source referred for performing restore operation
restoreNamespace
string
Namespace is a name of namespace in cluster where backed resources will be restored Deprecated: Restore will be allowed only in Restore CR Namespace so RestoreNamespace is redundant.
skipIfAlreadyExists
bool
SkipIfAlreadyExists specifies whether to skip restore of a resource if already exists in the namespace restored. Deprecated: SkipIfAlreadyExists flag is now moved under RestoreFlags struct
patchIfAlreadyExists
bool
PatchIfAlreadyExists specifies whether to patch spec of a already exists resource in the namespace restored. Deprecated: PatchIfAlreadyExists flag is now moved under RestoreFlags struct
patchCRD
bool
PatchCRD specifies whether to patch spec of a already exists crd. Deprecated: PatchCRD flag is now moved under RestoreFlags struct
omitMetadata
bool
OmitMetadata specifies whether to omit metadata like labels, annotations of resources while restoring them. Deprecated: OmitMetadata flag is now moved under RestoreFlags struct
skipOperatorResources
bool
SkipOperatorResources specifies whether to skip operator resources or not at the time of restore. (for the use case when operator is already present and the application of that operator needs to be restored) Deprecated: SkipOperatorResources flag is now moved under RestoreFlags struct
disableIgnoreResources
bool
DisableIgnoreResources is responsible for the behavior of default list of resources being ignored at the restore. If set to true, those resources will not be ignored Deprecated: DisableIgnoreResources flag is now moved under RestoreFlags struct
Env is the List of environment variables to set in the container. Cannot be updated.
TransformComponents specifies the component-wise transformation configuration
ExcludeResources specifies the resources to be excluded from backup while restoring
HookConfig specifies the Post Restore Hooks Executed in reverse sequence of the sequence specified here
cleanupOnFailure
bool
CleanupOnFailure is flag to perform cleanup after restore fails. Defaults to false Deprecated: CleanupOnFailure flag is now moved under ActionFlags struct
protectRestoredApp
bool
ProtectRestoredApp decides if T4K will setup a backupplan to protect the restored application. Deprecated: ProtectRestoredApp flag is now moved under ActionFlags struct
Encryption specify encryption key to decrypt the encrypted data.
resourcesReadyWaitSeconds
uint16
ResourcesReadyWaitSeconds is the wait time for restored application’s pods to come up. If user application is having webhook then CR creation will fail is webhook is not up. Provide the wait time in such case.
ImageRegistry specifies the configuration to restore container images.
RestoreStats defines the stats for a Restore
BackupPlan is the reference to BackupPlan associated with Restore
Backup is the reference to the Backup associated with Restore
RestoreStatus defines the observed state of Restore
RestoreScope indicates scope of component being restored i.e. App or Namespace.
ApplicationType is the type of Application restored in the App Scoped backup
StartTimestamp is the time a restore was started.
CompletionTimestamp is the time a restore was finished.
Phase is the current phase of the restore operation.
PhaseStatus is the status of phase restore operation going through.
Status is the status of the restore operation.
Size is the aggregate size of the data restored back.
percentageCompletion
byte
PercentageCompletion is the amount of restore operation completed.
RestoreApplication defines the information about the different applications restored back to cluster.
HookStatus specifies pre/post hook execution status for current backup.
Condition is the current condition of restore resource.
Duration is the amount of time the restore process took to finish.
ProtectingResources lists the Trilio resources and dependent resources which are getting created after user application restore operation. It’s applicable only if ProtectRestoredApp is set to true.
encryptionEnabled
bool
EncryptionEnabled flag shows that meta and data encryption is enabled.
RestoreSummary comprises of restore object references and count of restore with different statuses
LatestRestore is the reference to Latest Restore in any state, of a BackupPlan
LastSuccessfulRestore is the reference to Latest completed Restore of a BackupPlan
totalInProgressRestores
uint32
TotalInProgressRestores is the count of total number of InProgress Restores
totalCompletedRestores
uint32
TotalCompletedRestores is the count of total number of Completed Restores
totalFailedRestores
uint32
TotalFailedRestores is the count of total number of Failed Restores
RetentionConfig is the configuration for the PolicyType: Retention
latest
int
Latest is the max number of latest backups to be retained
weekly
int
Weekly is max number of backups to be retained in a week
monthly
int
Monthly is max number of backups to be retained in a month
yearly
int
Yearly is max number of backups to be retained in a year
DayOfWeek is Day of the week to maintain weekly backup/restore resources
dateOfMonth
int
DateOfMonth is Date of the month to maintain monthly backup/restore resources
MonthOfYear is the month of the backup to retain for yearly backups
ScanInstance specifies the info about Security ScanInstance and its related report summary
scanInstanceName
string
ScanInstanceName is the name of the ScanInstance triggered on the Security site
ScanTimestamp is the time stamp when scanning completed/failed
BackupScanInfo defines the scanning report for Backup or each Backup of a ClusterBackup It is the mapping of Backup-uuid and corresponding Scanning report
reportPath
string
ReportPath is the location of Scanning report on the target
totalScans
int
TotalScans denotes the total number of scans done for each type
scansPassed
int
ScansPassed denotes the number of scans passed out of TotalScans
Status is the status of the condition.
ReportSummary is the summary of vulnerabilities detected in the Security scanning
SchedulePolicy contains the object references for incremental or full backup type schedule policy
IncrementalCron is the cronspec schedule for incremental backups Deprecated: IncrementalCron will be used as an object reference of schedule type policy.
FullBackupCron is the cronspec schedule for full backups Deprecated: FullBackupCron will be used as an object reference of schedule type policy.
IncrementalBackupPolicy is the object reference for the policy of type schedule defined
FullBackupPolicy is the object reference for the policy of type schedule defined
string alias)Scope specifies the scope of a resource.
schedule
[]string
Schedule is the cron schedules for periodic scanning of Backups/ClusterBackups
retention
int
Retention is the number of Security Scan reports to be retained for each Backup
SecurityScanConfigInfo defines the Security Scan instances info which will be used for Backup/ClusterBackup scanning
SecurityServiceInstances defines the list of Security instances which will perform the Backup/ClusterBackup Security scanning
SecurityScanStatus specifies the details of Security scan status of an instance
securityEnabled
bool
SecurityEnabled denotes if the Security service is actually enabled on the Security site
ServiceStatus is the current Status of Security service Available/Unavailable. It is updated as per the heartbeat of Security service
LastScanTimestamp is the time stamp of the last scan performed on this BackupPlan/ClusterBackupPlan
LastSuccessfulScanScanTimestamp is the time of the last successful scan performed this BackupPlan/ClusterBackupPlan
scanPlan
string
ScanPlan denotes the name of ScanPlan created for this BackupPlan/ClusterBackupPlan on the Security site
ScanInstances defines the list of latest 3 Security ScanInstances which were triggered for a Backup/ClusterBackup Security scanning
SecurityServiceInstance defines details of Security Scan for InstanceID specified
instanceID
string
InstanceID is the unique Instance ID of the Security Service to be used for Security Scanning
SecurityScanPolicy is the object reference to the Security Scan Policy to be used for scanning
scanAllBackups
bool
ScanAllBackups enables Security Scan on all Backups/ClusterBackups of BackupPlan/ClusterBackupPlan (old and new)
Snapshot defines the snapshot contents of an Application Backup.
HelmCharts specifies the snapshot of application defined by Helm Charts.
Operators specifies the snapshot of application defined by Operators.
Custom specifies the snapshot of Custom defined applications.
Image specifies the snapshot of the all application’s container images.
VolumeSnapshotSourcePVC is the objectReference of the temporary PersistentVolumeClaim used for creating VolumeSnapshot
prePopulated
bool
PrePopulated field is a bool field which denotes if the PersistentVolumeClaim used is already populated with data or not
Size is the size of the actual data restored in the PVC.
VolumeSnapshot specifies the CSI snapshot of a Persistent Volume.
path
string
Path is the qcow2 path for the PersistentVolume data on the target
Conditions are the current statuses of restore PVCs.
SnapshotSize is the size of the volume snapshot of a Persistent Volume.
backupName
string
BackupName is the name of source Backup
backupNamespace
string
BackupNamespace is the namespace of source Backup
CompletionTimestamp is the time a backup was finished.
location
string
Location is the path of Backup on the target
TotalSize is the total size of data restored done for the Backup
PVCSnapshotInfo is the mapping of source original PersistentVolumeClaim name, and it’s corresponding Snapshot info
TransformStatus is the status of transformation performed
Status is the current Status of Backup data restore operation
kind
string
name
string
namespace
string
name
string
id
string
string alias)Status specifies the status of WorkloadJob operating on
Target is a location where Trilio stores backup.
Refer to the Kubernetes API documentation for the fields of the metadata field.
Type is the type of target for backup storage.
Vendor is the third party storage vendor hosting the target
NfsCredentials specifies the credentials for TargetType NFS
ObjectStoreCredentials specifies the credentials for TargetType ObjectStore
enableBrowsing
bool
EnableBrowsing specifies if target browser feature should be enabled for this target or not
ThresholdCapacity is the maximum threshold capacity to store backup data.
Type is the type of target for backup storage.
Vendor is the third party storage vendor hosting the target
NfsCredentials specifies the credentials for TargetType NFS
ObjectStoreCredentials specifies the credentials for TargetType ObjectStore
enableBrowsing
bool
EnableBrowsing specifies if target browser feature should be enabled for this target or not
ThresholdCapacity is the maximum threshold capacity to store backup data.
Type is the type of target for backup storage.
Vendor is the third party storage vendor hosting the target
NfsCredentials specifies the credentials for TargetType NFS
ObjectStoreCredentials specifies the credentials for TargetType ObjectStore
enableBrowsing
bool
EnableBrowsing specifies if target browser feature should be enabled for this target or not
ThresholdCapacity is the maximum threshold capacity to store backup data.
Type is the type of target for backup storage.
Vendor is the third party storage vendor hosting the target
NfsCredentials specifies the credentials for TargetType NFS
ObjectStoreCredentials specifies the credentials for TargetType ObjectStore
enableBrowsing
bool
EnableBrowsing specifies if target browser feature should be enabled for this target or not
ThresholdCapacity is the maximum threshold capacity to store backup data.
TargetCondition specifies the current condition of a target resource.
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.
TargetInfo contains minimal information about target populated in backup stats
Target is the reference to a Target backuped up
Type is the type of target for backup storage.
Vendor is the third party storage vendor hosting the target
TargetSpec defines the specification of a Target.
Type is the type of target for backup storage.
Vendor is the third party storage vendor hosting the target
NfsCredentials specifies the credentials for TargetType NFS
ObjectStoreCredentials specifies the credentials for TargetType ObjectStore
enableBrowsing
bool
EnableBrowsing specifies if target browser feature should be enabled for this target or not
ThresholdCapacity is the maximum threshold capacity to store backup data.
TargetStats defines the stats for a Target
totalBackupPlans
uint32
TotalBackupPlans is the count of total number of BackupPlans of a Target
CapacityOccupied is the aggregate of total size occupied on the Target by Backups
TargetStatus defines the observed state of Target
Condition is the current condition of a target.
Status is the final Status of target Available/Unavailable
browsingEnabled
bool
BrowsingEnabled specifies if target browser feature is enabled for this target or not
NFSPersistentVolume is the object reference to the PersistentVolume of NFS volume type with target NFS credentials
NFSPersistentVolumeClaim is the object reference to the PersistentVolumeClaim bound to NFS volume attached to the Container
defaultRetentionPeriod
uint16
DefaultRetentionPeriod is the period set by default on the target This value will always be in number of days
eventTargetEnabled
bool
EventTargetEnabled specifies if target is configured as Event target or not
availableContinuousRestoreInstances
map[string]string
AvailableContinuousRestoreInstances is the map of instance IDs to instance names which are available to be used as ContinuousRestore site
availableSecurityInstances
map[string]string
AvailableSecurityInstances is the map of instance IDs to instance names which are available to be used as SecurityScanning site
string alias)TargetType is the type of target.
TimeoutConfig is the configuration for the PolicyType: Timeout
TransformComponents specifies component wise transformation configuration
HelmTransform specifies the Transformation configuration for Helm charts
CustomTransform specifies the Transformation configuration for Custom label-based backup
TransformStatus specifies the details of transform operation
transformName
string
TransformName is the name of transformation
Status is the status of transform operation
TransformedResources Specifies the resources transformed as part of transformation
reason
string
Reason is reason for status in case of failure
Errors is the reason for transformation failure.
TransformationError defines the set of errors against names of a Kubernetes resource of a particular GVK.
GroupVersionKind specifies GVK uniquely representing particular resource type.
objects
map[string]string
Objects is the map of errors against an object name
string alias)Vendor is the third party storage vendor hosting the target
nolint:lll // directive continuation
VolumeSnapshot defines the CSI snapshot of a Persistent Volume.
VolumeSnapshot is a reference to the Persistent Volume Snapshot captured.
retryCount
byte
RetryCount is the number of attempts made to capture Volume Snapshot.
Status is the status defining the progress of Volume Snapshot capture.
error
string
Error is the error occurred while capturing Volume Snapshot if any.
Generated with gen-crd-api-reference-docs on git commit 0c652de798.
metadata
spec
type
backupPlan
type
backupPlan
type
backupPlan
type
backupPlan
status
(Appears on: , )
hookConfig
includeResources
excludeResources
BackupComponent
PartOf
(Appears on: )
status
timestamp
phase
(Appears on: )
target
retentionPolicy
schedulePolicy
(Appears on: )
backup
status
metadata
spec
backupConfig
backupPlanComponents
hookConfig
includeResources
excludeResources
encryption
securityScanConfig
continuousRestoreConfig
backupPlanFlags
backupConfig
backupPlanComponents
hookConfig
includeResources
excludeResources
encryption
securityScanConfig
continuousRestoreConfig
backupPlanFlags
backupConfig
backupPlanComponents
hookConfig
includeResources
excludeResources
encryption
securityScanConfig
continuousRestoreConfig
backupPlanFlags
backupConfig
backupPlanComponents
hookConfig
includeResources
excludeResources
encryption
securityScanConfig
continuousRestoreConfig
backupPlanFlags
status
(Appears on: )
operators
custom
customSelector
(Appears on: )
status
timestamp
phase
(Appears on: , )
(Appears on: )
backupPlan
partOf
status
(Appears on: , )
(Appears on: )
backupConfig
backupPlanComponents
hookConfig
includeResources
excludeResources
encryption
securityScanConfig
continuousRestoreConfig
backupPlanFlags
(Appears on: )
backupSummary
restoreSummary
(Appears on: )
condition
status
scope
applicationType
incrementalCron
fullBackupCron
incrementalCrons
fullBackupCrons
stats
securityScanStatus
continuousRestoreStatus
(Appears on: )
metadataScannerStatus
dataScannerStatus
imageScannerStatus
(Appears on: )
type
backupPlan
(Appears on: )
target
targetInfo
latestInProgressRestore
latestCompletedRestore
encryption
(Appears on: )
backupScope
applicationType
type
startTimestamp
completionTimestamp
phase
phaseStatus
status
size
expirationTimestamp
snapshot
condition
hookStatus
stats
securityScanStatus
consistentSetStatus
duration
(Appears on: )
inProgressBackup
lastSuccessfulBackup
latestBackup
(Appears on: , , , , , )
(Appears on: )
metadata
spec
type
clusterBackupPlan
type
clusterBackupPlan
type
clusterBackupPlan
type
clusterBackupPlan
status
(Appears on: )
phase
status
timestamp
(Appears on: )
target
retentionPolicy
schedulePolicy
metadata
spec
backupComponents
namespaceSelector
backupConfig
includeResources
excludeResources
encryption
securityScanConfig
continuousRestoreConfig
clusterBackupPlanFlags
backupComponents
namespaceSelector
backupConfig
includeResources
excludeResources
encryption
securityScanConfig
continuousRestoreConfig
clusterBackupPlanFlags
backupComponents
namespaceSelector
backupConfig
includeResources
excludeResources
encryption
securityScanConfig
continuousRestoreConfig
clusterBackupPlanFlags
backupComponents
namespaceSelector
backupConfig
includeResources
excludeResources
encryption
securityScanConfig
continuousRestoreConfig
clusterBackupPlanFlags
status
(Appears on: )
status
timestamp
phase
phase
phase
phase
(Appears on: )
backupComponents
namespaceSelector
backupConfig
includeResources
excludeResources
encryption
securityScanConfig
continuousRestoreConfig
clusterBackupPlanFlags
(Appears on: )
clusterBackupSummary
clusterRestoreSummary
(Appears on: )
status
backupPlans
incrementalCrons
fullBackupCrons
condition
stats
securityScanStatus
continuousRestoreStatus
(Appears on: )
incrementalBackupPolicy
fullBackupPolicy
(Appears on: )
type
clusterBackupPlan
(Appears on: )
target
targetInfo
latestInProgressClusterRestore
lastCompletedClusterRestore
encryption
(Appears on: )
type
startTimestamp
completionTimestamp
status
size
expirationTimestamp
condition
duration
backupInfos
stats
securityScanStatus
consistentSetStatus
(Appears on: )
inProgressClusterBackup
lastSuccessfulClusterBackup
latestClusterBackup
metadata
spec
source
globalConfig
components
actionFlags
encryption
imageRegistry
source
globalConfig
components
actionFlags
encryption
imageRegistry
source
globalConfig
components
actionFlags
encryption
imageRegistry
source
globalConfig
components
actionFlags
encryption
imageRegistry
status
(Appears on: )
phase
status
timestamp
(Appears on: )
type
clusterBackup
target
clusterBackupPlan
consistentSet
(Appears on: )
(Appears on: )
source
globalConfig
components
actionFlags
encryption
imageRegistry
(Appears on: )
clusterBackupPlan
clusterBackup
(Appears on: )
startTimestamp
completionTimestamp
phase
phaseStatus
status
size
condition
duration
components
stats
protectingResources
(Appears on: )
lastSuccessfulClusterRestore
latestClusterRestore
(Appears on: )
restoreConfig
hookConfig
(Appears on: )
backup
restore
restoreStatus
(Appears on: , , )
(Appears on: , , )
existingResource
skippedResources
failedResources
newResourcesAdded
excludedResources
failedCleanupResources
transformStatus
phase
phaseStatus
(Appears on: , )
status
timestamp
phase
metadata
spec
continuousRestorePlan
transformComponents
continuousRestorePlan
transformComponents
continuousRestorePlan
transformComponents
continuousRestorePlan
transformComponents
status
(Appears on: )
phase
status
timestamp
(Appears on: , , )
consistentSetStatus
consistentSetCreationTimeStamp
consistentSetCompletionTimeStamp
size
(Appears on: )
(Appears on: )
continuousRestorePlan
transformComponents
(Appears on: )
sourceBackupPlan
sourceInstanceInfo
(Appears on: )
status
scope
startTimestamp
completionTimestamp
backupInfo
size
phase
phaseStatus
condition
duration
stats
(Appears on: )
preHookStatus
postHookStatus
(Appears on: )
imagePullSecrets
(Appears on: )
(Appears on: , )
continuousRestoreInstances
(Appears on: )
continuousRestorePolicy
transformComponents
metadata
spec
continuousRestorePolicy
target
transformComponents
continuousRestorePolicy
target
transformComponents
continuousRestorePolicy
target
transformComponents
continuousRestorePolicy
target
transformComponents
status
(Appears on: )
status
timestamp
phase
(Appears on: )
continuousRestorePolicy
target
transformComponents
(Appears on: )
condition
status
consistentSetInfo
(Appears on: , )
continuousRestoreSiteStatus
lastConsistentSetCreationTimestamp
lastSuccessfulConsistentSetTimestamp
(Appears on: )
(Appears on: )
(Appears on: , )
resources
dataSnapshots
(Appears on: )
selectResources
excludeResources
(Appears on: )
resources
jsonPatches
(Appears on: , , )
backupType
volumeSnapshot
pvSize
snapshotSize
size
podContainersMap
conditions
(Appears on: )
(Appears on: , , , , , )
encryptionSecret
(Appears on: )
groupVersionKind
(Appears on: , , , )
(Appears on: , , )
resource
resources
storageBackend
version
dataSnapshots
(Appears on: )
(Appears on: )
set
(Appears on: )
metadata
spec
pre
post
pre
post
pre
post
pre
post
status
(Appears on: , )
hookPriorityStatus
(Appears on: , , , , )
mode
hooks
(Appears on: )
(Appears on: )
execAction
(Appears on: )
hook
podSelector
(Appears on: )
hook
preHookConf
postHookConf
hookTarget
(Appears on: )
hooks
(Appears on: )
pre
post
(Appears on: )
(Appears on: )
owner
podHookStatus
(Appears on: )
imageSnapshot
(Appears on: )
referencedBy
imagePullSecrets
(Appears on: , )
registryAuthSecret
(Appears on: , )
backupType
size
containerImages
(Appears on: )
metadata
spec
status
(Appears on: )
status
timestamp
phase
(Appears on: )
(Appears on: )
edition
creationTimestamp
purchaseTimestamp
expirationTimestamp
maintenanceExpiryTimestamp
scope
(Appears on: )
(Appears on: , )
(Appears on: )
status
properties
condition
gracePeriodStartTimestamp
gracePeriodEndTimestamp
(Appears on: )
(Appears on: )
status
timestamp
(Appears on: )
(Appears on: )
labelSelector
hookConfig
includeResources
excludeResources
(Appears on: )
credentialSecret
(Appears on: )
(Appears on: , , , , , , , , , , , , )
(Appears on: , )
customResources
helm
operatorResources
applicationResources
dataSnapshots
(Appears on: )
customResources
operatorResourceSelector
operatorResources
applicationResourceSelector
applicationResources
excludeResources
(Appears on: )
groupVersionKind
(Appears on: )
op
(Appears on: )
(Appears on: )
containerHookStatus
(Appears on: )
labels
metadata
spec
type
retentionConfig
timeoutConfig
cleanupConfig
scheduleConfig
securityScanConfig
continuousRestoreConfig
type
retentionConfig
timeoutConfig
cleanupConfig
scheduleConfig
securityScanConfig
continuousRestoreConfig
type
retentionConfig
timeoutConfig
cleanupConfig
scheduleConfig
securityScanConfig
continuousRestoreConfig
type
retentionConfig
timeoutConfig
cleanupConfig
scheduleConfig
securityScanConfig
continuousRestoreConfig
status
(Appears on: )
type
retentionConfig
timeoutConfig
cleanupConfig
scheduleConfig
securityScanConfig
continuousRestoreConfig
(Appears on: )
(Appears on: )
(Appears on: )
status
(Appears on: )
(Appears on: , , , , , , , , , , , )
groupVersionKind
(Appears on: , , , , , )
labelSelector
gvkSelector
metadata
spec
source
restoreFlags
actionFlags
env
transformComponents
excludeResources
hookConfig
encryption
imageRegistry
source
restoreFlags
actionFlags
env
transformComponents
excludeResources
hookConfig
encryption
imageRegistry
source
restoreFlags
actionFlags
env
transformComponents
excludeResources
hookConfig
encryption
imageRegistry
source
restoreFlags
actionFlags
env
transformComponents
excludeResources
hookConfig
encryption
imageRegistry
status
(Appears on: )
helmCharts
operators
custom
image
(Appears on: )
status
timestamp
phase
(Appears on: , )
restoreFlags
transformComponents
excludeResources
(Appears on: )
snapshot
status
(Appears on: , )
(Appears on: )
snapshot
status
(Appears on: )
imageSnapshot
(Appears on: )
snapshot
status
(Appears on: , , )
(Appears on: )
type
backup
target
backupPlan
consistentSet
(Appears on: )
(Appears on: )
source
restoreFlags
actionFlags
env
transformComponents
excludeResources
hookConfig
encryption
imageRegistry
(Appears on: )
backupPlan
backup
(Appears on: )
restoreScope
applicationType
startTimestamp
completionTimestamp
phase
phaseStatus
status
size
restoreApplication
hookStatus
condition
stats
duration
protectingResources
(Appears on: )
latestRestore
lastSuccessfulRestore
(Appears on: )
dayOfWeek
monthOfYear
(Appears on: )
scanTimestamp
backupScanInfo
(Appears on: )
status
reportSummary
(Appears on: )
incrementalCron
fullBackupCron
incrementalBackupPolicy
fullBackupPolicy
(Appears on: )
(Appears on: )
(Appears on: , )
securityServiceInstances
(Appears on: , )
serviceStatus
lastScanTimestamp
lastSuccessfulScanScanTimestamp
(Appears on: , )
scanInstances
(Appears on: )
securityScanPolicy
(Appears on: )
helmCharts
operators
custom
image
(Appears on: )
volumeSnapshotSourcePVC
size
volumeSnapshot
conditions
snapshotSize
(Appears on: )
completionTimestamp
size
pvcSnapshotInfo
transformStatus
status
(Appears on: )
(Appears on: )
(Appears on: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , )
metadata
spec
type
vendor
nfsCredentials
objectStoreCredentials
thresholdCapacity
type
vendor
nfsCredentials
objectStoreCredentials
thresholdCapacity
type
vendor
nfsCredentials
objectStoreCredentials
thresholdCapacity
type
vendor
nfsCredentials
objectStoreCredentials
thresholdCapacity
status
(Appears on: )
status
timestamp
phase
(Appears on: , )
target
type
vendor
(Appears on: )
type
vendor
nfsCredentials
objectStoreCredentials
thresholdCapacity
(Appears on: )
capacityOccupied
applicationCapacity
applicationCapacityConsumed
(Appears on: )
condition
status
stats
nfsPersistentVolume
nfsPersistentVolumeClaim
(Appears on: , )
(Appears on: )
(Appears on: , , , , )
helm
custom
(Appears on: , )
status
transformedResources
-
(Appears on: )
groupVersionKind
(Appears on: , )
(Appears on: , )
volumeSnapshot
status
key
string
Key is the product key to use triliovault application to perform backup/restore.
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.
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.
Type is the type of clusterBackup in the sequence of clusterBackups.
ClusterBackupPlan is a reference to the ClusterBackupPlan to be backed up.
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.
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
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
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
PreHook is the Hook executed to quiesce the application before backup operation
PostHook is the Hook executed to unquiesce the application after backup operation
Type is a field of Policy spec, which defines the policy type containing only 3 values: Retention, Timeout, Cleanup.
default
bool
Default field states if the current type of policy is default across the TV application
RetentionConfig field defines the configuration for Retention policy
TimeoutConfig field defines the configuration for timeout policy
CleanupConfig field defines the configuration for Cleanup policy
ScheduleConfig field defines the configuration for Schedule policy
SecurityScanConfig field defines the configuration for SecurityScan policy
ContinuousRestoreConfig field defines the configuration for ContinuousRestore policy
Source defines the source referred for performing restore operation
restoreNamespace
string
Namespace is a name of namespace in cluster where backed resources will be restored Deprecated: Restore will be allowed only in Restore CR Namespace so RestoreNamespace is redundant.
skipIfAlreadyExists
bool
SkipIfAlreadyExists specifies whether to skip restore of a resource if already exists in the namespace restored. Deprecated: SkipIfAlreadyExists flag is now moved under RestoreFlags struct
patchIfAlreadyExists
bool
PatchIfAlreadyExists specifies whether to patch spec of a already exists resource in the namespace restored. Deprecated: PatchIfAlreadyExists flag is now moved under RestoreFlags struct
patchCRD
bool
PatchCRD specifies whether to patch spec of a already exists crd. Deprecated: PatchCRD flag is now moved under RestoreFlags struct
omitMetadata
bool
OmitMetadata specifies whether to omit metadata like labels, annotations of resources while restoring them. Deprecated: OmitMetadata flag is now moved under RestoreFlags struct
skipOperatorResources
bool
SkipOperatorResources specifies whether to skip operator resources or not at the time of restore. (for the use case when operator is already present and the application of that operator needs to be restored) Deprecated: SkipOperatorResources flag is now moved under RestoreFlags struct
disableIgnoreResources
bool
DisableIgnoreResources is responsible for the behavior of default list of resources being ignored at the restore. If set to true, those resources will not be ignored Deprecated: DisableIgnoreResources flag is now moved under RestoreFlags struct
Env is the List of environment variables to set in the container. Cannot be updated.
TransformComponents specifies the component-wise transformation configuration
ExcludeResources specifies the resources to be excluded from backup while restoring
HookConfig specifies the Post Restore Hooks Executed in reverse sequence of the sequence specified here
cleanupOnFailure
bool
CleanupOnFailure is flag to perform cleanup after restore fails. Defaults to false Deprecated: CleanupOnFailure flag is now moved under ActionFlags struct
protectRestoredApp
bool
ProtectRestoredApp decides if T4K will setup a backupplan to protect the restored application. Deprecated: ProtectRestoredApp flag is now moved under ActionFlags struct
Encryption specify encryption key to decrypt the encrypted data.
resourcesReadyWaitSeconds
uint16
ResourcesReadyWaitSeconds is the wait time for restored application’s pods to come up. If user application is having webhook then CR creation will fail is webhook is not up. Provide the wait time in such case.
ImageRegistry specifies the configuration to restore container images.
Type is the type of target for backup storage.
Vendor is the third party storage vendor hosting the target
NfsCredentials specifies the credentials for TargetType NFS
ObjectStoreCredentials specifies the credentials for TargetType ObjectStore
enableBrowsing
bool
EnableBrowsing specifies if target browser feature should be enabled for this target or not
ThresholdCapacity is the maximum threshold capacity to store backup data.
type
backupPlan
backupConfig
backupPlanComponents
hookConfig
includeResources
excludeResources
encryption
securityScanConfig
continuousRestoreConfig
backupPlanFlags
type
clusterBackupPlan
backupComponents
namespaceSelector
backupConfig
includeResources
excludeResources
encryption
securityScanConfig
continuousRestoreConfig
clusterBackupPlanFlags
source
globalConfig
components
actionFlags
encryption
imageRegistry
continuousRestorePlan
transformComponents
continuousRestorePolicy
target
transformComponents
pre
post
type
retentionConfig
timeoutConfig
cleanupConfig
scheduleConfig
securityScanConfig
continuousRestoreConfig
source
restoreFlags
actionFlags
env
transformComponents
excludeResources
hookConfig
encryption
imageRegistry
type
vendor
nfsCredentials
objectStoreCredentials
thresholdCapacity