Custom Resource Definition - Application
API reference for Trilio Application
Deprecated Documentation
This document is deprecated and no longer supported. For accurate, up-to-date information, please refer to the documentation for the latest version of Trilio.
# Custom Resource Definition - Application
Packages: triliovault.trilio.io/v1
Package v1 contains API Schema definitions for the triliocrds v1 API group. Resource Types are as follows:
ActionFlags
(Appears on: ClusterRestoreSpec, RestoreSpec)
| Field | Description |
|---|---|
| CleanupOnFailure is flag to perform cleanup after restore fails. Defaults to false |
| ProtectRestoredApp decides if T4K will setup a backupPlan to protect the restored application. |
ApplicationType (string alias)
string alias)(Appears on: BackupPlanStatus, BackupStatus, RestoreStatus)
ApplicationType specifies type of a Backup of an application
Backup
Backup represents the capture of Kubernetes BackupPlan defined by user at a point in time
| Field | Description |
|---|---|
| Refer to the Kubernetes API documentation for the fields of the |
|
|
| Type is the type of backup in the sequence of backups of an Application. |
| BackupPlan is a reference to the BackupPlan to be backed up. |
| Type is the type of backup in the sequence of backups of an Application. |
| BackupPlan is a reference to the BackupPlan to be backed up. |
| Type is the type of backup in the sequence of backups of an Application. |
| BackupPlan is a reference to the BackupPlan to be backed up. |
|
BackupComponent
(Appears on: BackupComponentInfo, ClusterBackupPlanSpec)
BackupComponent defines the namespace and their configurations for backup
| Field | Description |
|---|---|
| |
| hookConfig defines backup pre/post hooks and their configurations. |
| IncludeResources specifies the resources included during backup |
| ExcludedResources specifies the resources excluded during backup |
BackupComponentInfo
| Field | Description |
|---|---|
| |
| |
|
BackupCondition
(Appears on: BackupStatus)
BackupCondition specifies the current condition of a backup resource.
| Field | Description |
|---|---|
| Status is the status of the condition. |
| Timestamp is the time a condition occurred. |
| A brief message indicating details about why the component is in this condition. |
| Phase defines the current phase of the controller. nolint:lll // directive continuation |
BackupConfig
(Appears on: BackupPlanSpec)
BackupConfig defines the require configuration for taking the backup such as target and retention policy. NOTE: ClusterBackupConfig field in clusterbackupplan_types.go is similar to this structure. Changes made here might be required to be reflected there as well.
| Field | Description |
|---|---|
Target is the object reference for the backup target resources | |
| RetentionPolicy is the object reference for the policy of type retention defined |
| SchedulePolicy includes the object references of 2 type of cron schedule policy: incremental and full |
| MaxIncrBackupsPerFullBackup is the number of incremental backups after which full backup will ge triggered. This is relevant only in case of immutable backups |
BackupInfo
(Appears on: ClusterBackupStatus)
BackupInfo contains the relevant information to uniquely identify a child Backup created from a ClusterBackup
| Field | Description |
|---|---|
Backup ObjectReference of child Backup | |
| Status status of child Backup |
| PercentageCompletion is the amount of backup operation completed. |
| Location is the Backup’s location on the target |
BackupPlan
BackupPlan is the Schema for the BackupPlan API
| Field | Description |
|---|---|
| Refer to the Kubernetes API documentation for the fields of the |
|
|
| 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 |
| ExcludeResources specify resources to exclude for namespace scope backup based on |
| Encryption specify how to encrypt backups on target for this backupPlan |
| 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 |
| ExcludeResources specify resources to exclude for namespace scope backup based on |
| Encryption specify how to encrypt backups on target for this backupPlan |
| 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 |
| ExcludeResources specify resources to exclude for namespace scope backup based on |
| Encryption specify how to encrypt backups on target for this backupPlan |
|
BackupPlanComponents
(Appears on: BackupPlanSpec)
BackupPlanComponents contains the 3 types of components, helm charts, operators and custom label-based resources
| Field | Description |
|---|---|
| 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 |
BackupPlanInfo
(Appears on: ClusterBackupPlanStatus)
BackupPlanInfo defines the object reference and status of a backupPlan
| Field | Description |
|---|---|
| BackupPlan is the object reference of a backupPlan |
| PartOf specify how backupPlan is selected, it could be by NamespaceSelector or by BackupComponent |
| Name will specify namespace selector’s name if backupPlan is PartOf |
| Status is the status of the backupPlan |
BackupPlanSelector (string alias)
string alias)(Appears on: BackupComponentInfo, BackupPlanInfo)
BackupPlanSelector used in ClusterBackupPlan Status to identify how corresponding backupPlan is selected by, it could be by NamespaceSelector or by BackupComponent
BackupPlanSpec
(Appears on: BackupPlan)
BackupPlanSpec defines the desired state of BackupPlan
| Field | Description |
|---|---|
| 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 |
| ExcludeResources specify resources to exclude for namespace scope backup based on |
| Encryption specify how to encrypt backups on target for this backupPlan |
BackupPlanStats
(Appears on: BackupPlanStatus)
BackupPlanStats defines the stats for a BackupPlan
| Field | Description |
|---|---|
| |
| |
| Immutable specify whether a backup data is going to be immutable. |
BackupPlanStatus
(Appears on: BackupPlan)
BackupPlanStatus defines the observed state of BackupPlan
| Field | Description |
|---|---|
| Status 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 |
| |
| |
|
BackupScheduleType (string alias)
string alias)BackupScheduleType specifies the type of schedule which triggered the backup
BackupSpec
(Appears on: Backup)
BackupSpec defines the desired state of Backup
| Field | Description |
|---|---|
| Type is the type of backup in the sequence of backups of an Application. |
| BackupPlan is a reference to the BackupPlan to be backed up. |
BackupStats
(Appears on: BackupStatus)
BackupStats specifies the stats of a Backup
| Field | Description |
|---|---|
Target is the reference to a Target backuped up Deprecated: Target information moved to TargetInfo field | |
| TargetInfo is the information to a Target backed up |
| LatestInProgressRestore is the reference to the latest InProgress Restore of a Backup |
| LatestCompletedRestore is the reference to the latest Completed Restore of a Backup |
| HookExists is a bool value that states if a backup has hooks in backup plan |
| Encryption specifies encryption details of a backup |
| Immutable specify whether a backup data is immutable |
BackupStatus
(Appears on: Backup)
BackupStatus defines the observed state of Backup
| Field | Description |
|---|---|
| BackupScope indicates scope of component in backup i.e. App or Namespace. |
| ApplicationType is the type of Application backed up in the App Scoped backup |
| Type indicates the backup type in backup i.e. Full, Incremental or Mixed. |
| Location 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 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. |
| |
| Duration is the amount of time the backup process took to finish. |
BackupSummary
(Appears on: BackupPlanStats)
BackupSummary comprises of backup object references and count of backups with different statuses
| Field | Description |
|---|---|
| InProgressBackup is the reference to an InProgress backup of a BackupPlan |
| LastSuccessfulBackup is the reference to Latest available Backup of a BackupPlan |
| LatestBackup is the reference to Latest Backup in any state, of a BackupPlan |
| TotalAvailableBackups is the count of total number of Available Backups |
| TotalFailedBackups is the count of total number of InProgress Backups |
| TotalQueuedBackups is the count of total number of Queued Backups |
| PVCExistsForBackup is a bool value that states if the latest backup of a backup plan has PVCs in its data component |
BackupType (string alias)
string alias)(Appears on: BackupSpec, BackupStatus, ClusterBackupSpec, ClusterBackupStatus, DataSnapshot)
BackupType defines the type backup instance of an BackupPlan
CleanupConfig
(Appears on: PolicySpec)
CleanupConfig is the configuration for the PolicyType: Cleanup
| Field | Description |
|---|---|
| BackupDays is the age of backups to be cleaned |
ClusterBackup
ClusterBackup is the Schema for the ClusterBackup API
| Field | Description |
|---|---|
| Refer to the Kubernetes API documentation for the fields of the |
|
|
| Type is the type of clusterBackup in the sequence of clusterBackups. |
| ClusterBackupPlan is a reference to the ClusterBackupPlan to be backed up. |
| Type is the type of clusterBackup in the sequence of clusterBackups. |
| ClusterBackupPlan is a reference to the ClusterBackupPlan to be backed up. |
| Type is the type of clusterBackup in the sequence of clusterBackups. |
| ClusterBackupPlan is a reference to the ClusterBackupPlan to be backed up. |
|
ClusterBackupCondition
(Appears on: ClusterBackupStatus)
ClusterBackupCondition specifies the current condition of a clusterBackup resource.
| Field | Description |
|---|---|
| Phase defines the current phase of the controller. |
| Status is the status of the condition. |
| Timestamp is the time a condition occurred. |
| A brief message indicating details about why clusterBackup is in this condition. |
ClusterBackupConfig
(Appears on: ClusterBackupPlanSpec)
ClusterBackupConfig defines the require configuration for taking the backup such as target and retention policy. NOTE: BackupConfig field in backupplan_types.go is similar to this structure. Changes made here might be required to be reflected there as well.
| Field | Description |
|---|---|
Target is the object reference for the backup target resources | |
| RetentionPolicy is the object reference for the policy of type retention defined |
| SchedulePolicy includes the object references of 2 type of cron schedule policy: incremental and full |
| MaxIncrBackupsPerFullBackup is the number of incremental backups after which full backup will ge triggered. This is relevant only in case of immutable backups |
ClusterBackupPlan
ClusterBackupPlan is the Schema for the ClusterBackupPlan API
| Field | Description |
|---|---|
| Refer to the Kubernetes API documentation for the fields of the |
|
|
| 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 |
| 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 |
| 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 |
|
ClusterBackupPlanCondition
(Appears on: ClusterBackupPlanStatus)
ClusterBackupPlanCondition specifies the current condition of a cluster backup plan resource.
| Field | Description |
|---|---|
| Status is the status of the condition. |
| Timestamp is the time a condition occurred. |
| A brief message indicating details about why the component is in this condition. |
ClusterBackupPlanSpec
(Appears on: ClusterBackupPlan)
ClusterBackupPlanSpec defines the desired state of ClusterBackupPlan
| Field | Description |
|---|---|
| BackupComponents 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 |
ClusterBackupPlanStats
(Appears on: ClusterBackupPlanStatus)
ClusterBackupPlanStats defines the stats for a ClusterBackupPlan
| Field | Description |
|---|---|
| |
| |
| Immutable specify whether a backup data is going to be immutable |
ClusterBackupPlanStatus
(Appears on: ClusterBackupPlan)
ClusterBackupPlanStatus defines the observed state of ClusterBackupPlan
| Field | Description |
|---|---|
| Status defines the current state of the ClusterBackupPlan resource. |
| 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. |
|
ClusterBackupSchedulePolicy
(Appears on: ClusterBackupConfig)
ClusterBackupSchedulePolicy contains the object references for incremental or full backup type schedule policy
| Field | Description |
|---|---|
| IncrementalBackupPolicy is the object reference for the policy of type schedule defined |
| FullBackupPolicy is the object reference for the policy of type schedule defined |
ClusterBackupSpec
(Appears on: ClusterBackup)
ClusterBackupSpec defines the desired state of ClusterBackup
| Field | Description |
|---|---|
| Type is the type of clusterBackup in the sequence of clusterBackups. |
| ClusterBackupPlan is a reference to the ClusterBackupPlan to be backed up. |
ClusterBackupStats
(Appears on: ClusterBackupStatus)
ClusterBackupStats specifies the stats of a ClusterBackup
| Field | Description |
|---|---|
Target is the reference to a Target backuped up Deprecated: Target information moved to TargetInfo field | |
| TargetInfo is the information to a Target backed up |
| LatestInProgressClusterRestore is the reference to the latest InProgress ClusterRestore of a ClusterBackup |
| LastCompletedClusterRestore is the reference to the latest Completed ClusterRestore of a ClusterBackup |
| HookExists is a bool value that states if a ClusterBackup has hooks in ClusterBackupPlan |
| Encryption specifies encryption details of a ClusterBackup |
| Immutable specify whether a clusterBackup data is immutable |
ClusterBackupStatus
(Appears on: ClusterBackup)
ClusterBackupStatus defines the observed state of ClusterBackup
| Field | Description |
|---|---|
| Type indicates the ClusterBackup type in backup i.e. Full, Incremental or Mixed. |
| Location 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 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 |
|
ClusterBackupSummary
(Appears on: ClusterBackupPlanStats)
ClusterBackupSummary comprises of ClusterBackup object references and count of ClusterBackups with different statuses
| Field | Description |
|---|---|
| InProgressClusterBackup is the reference to an InProgress ClusterBackup of a ClusterBackupPlan |
| LastSuccessfulClusterBackup is the reference to Latest available ClusterBackup of a ClusterBackupPlan |
| LatestClusterBackup is the reference to Latest ClusterBackup in any state, of a ClusterBackupPlan |
| TotalAvailableClusterBackups is the count of total number of Available ClusterBackups |
| TotalFailedClusterBackups is the count of total number of Failed ClusterBackups. |
| TotalQueuedClusterBackups is the count of total number of Queued ClusterBackups. |
| PVCExistsForBackup is a bool value that states if the latest clusterBackup of a clusterBackupPlan has any backup that has PVCs in its data component |
ClusterRestore
ClusterRestore defines the desired state of ClusterRestore
| Field | Description |
|---|---|
| Refer to the Kubernetes API documentation for the fields of the |
|
|
| 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 specifies the components(namespaces) to be excluded from the ClusterRestore |
| CleanupOnFailure is flag to perform cleanup for all restores when ClusterRestore has failed. Deprecated: CleanupOnFailure flag is now moved under |
| |
| Encryption specify encryption key to decrypt the encrypted data. |
| 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 specifies the components(namespaces) to be excluded from the ClusterRestore |
| CleanupOnFailure is flag to perform cleanup for all restores when ClusterRestore has failed. Deprecated: CleanupOnFailure flag is now moved under |
| |
| Encryption specify encryption key to decrypt the encrypted data. |
| 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 specifies the components(namespaces) to be excluded from the ClusterRestore |
| CleanupOnFailure is flag to perform cleanup for all restores when ClusterRestore has failed. Deprecated: CleanupOnFailure flag is now moved under |
| |
| Encryption specify encryption key to decrypt the encrypted data. |
|
ClusterRestoreCondition
(Appears on: ClusterRestoreStatus)
| Field | Description |
|---|---|
| Phase defines the current phase of the controller. |
| Status is the status of the cluster restore. |
| Timestamp is the time a condition occurred. |
| A brief message indicating details about why the component is in this condition. |
ClusterRestoreSource
(Appears on: ClusterRestoreSpec)
| Field | Description |
|---|---|
| Type is the type of source for restore |
| ClusterBackup is a reference to the ClusterBackup instance restored if type is ClusterBackup. |
Target is a reference to the Target instance where from restore is performed if type is Location. | |
| Location is an absolute path to remote target from where restore is performed if type is Location. |
| ClusterBackupPlan is a reference to the ClusterBackupPlan whose latest successful backup is to be restored. |
ClusterRestoreSourceType (string alias)
string alias)(Appears on: ClusterRestoreSource)
ClusterRestoreSpec
(Appears on: ClusterRestore)
ClusterRestoreSpec defines the source from where the ClusterRestore is to be done
| Field | Description |
|---|---|
| Type is the type of source for ClusterRestore |
| GlobalConfig is the global restore configuration which is applicable for the components of restore unless explicitly overridden at the component level |
| Components defines the components and their custom configuration using which individual component restore is to be done |
| ExcludeComponents specifies the components(namespaces) to be excluded from the ClusterRestore |
| CleanupOnFailure is flag to perform cleanup for all restores when ClusterRestore has failed. Deprecated: CleanupOnFailure flag is now moved under |
| |
| Encryption specify encryption key to decrypt the encrypted data. |
ClusterRestoreStats
(Appears on: ClusterRestoreStatus)
ClusterRestoreStats defines the stats for a RestorCluster
| Field | Description |
|---|---|
| ClusterBackupPlan is the reference to ClusterBackupPlan associated with ClusterRestore |
| ClusterBackup is the reference to the ClusterBackup associated with ClusterRestore |
ClusterRestoreStatus
(Appears on: ClusterRestore)
ClusterRestoreStatus defines the observed state of ClusterRestore
| Field | Description |
|---|---|
| StartTimestamp is the time when ClusterRestore was started. |
| CompletionTimestamp is the time when ClusterRestore finished. |
| Phase 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 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 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. |
ClusterRestoreSummary
(Appears on: ClusterBackupPlanStats)
ClusterRestoreSummary comprises of ClusterRestore object references and count of ClusterRestore with different statuses
| Field | Description |
|---|---|
| LastSuccessfulClusterRestore is the reference to Latest completed ClusterRestore of a ClusterBackupPlan |
| TotalInProgressClusterRestores is the count of total number of InProgress ClusterRestores |
| TotalCompletedClusterRestores is the count of total number of Completed ClusterRestores |
| TotalFailedClusterRestores is the count of total number of Failed ClusterRestores |
ComponentConfig
(Appears on: ClusterRestoreSpec)
| Field | Description |
|---|---|
| |
| |
| |
|
ComponentInfo
(Appears on: ClusterRestoreStatus)
| Field | Description |
|---|---|
| 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 is the amount of restore operation completed. |
ComponentScope (string alias)
string alias)(Appears on: BackupPlanStatus, BackupStatus, RestoreStatus)
ComponentScope indicates scope of components i.e. [App or Namespace] present in backup or restore
ComponentStatus
(Appears on: RestoreCustom, RestoreHelm, RestoreOperator)
ComponentStatus defines the details of restore of application component.
| Field | Description |
|---|---|
| ExistingResource specifies the resources already existing in cluster defined in application. |
| SkippedResources specifies the resources skipped while restoring. |
| FailedResources specifies the resources for which the restore operation failed |
| NewResourcesAdded specifies the resources added(duplicated and modified) during restore. |
| ExcludedResources specifies the resources excluded during restore |
| FailedCleanupResources specified the resources which doesn’t get clean up in failed restore |
| TransformStatus is the status of transformation performed |
| Phase is the current phase of the application component while restore. |
| PhaseStatus is the status of phase restore operation going through. |
| A brief message indicating details about why the application component is in this state. |
Conditions
(Appears on: DataSnapshot)
| Field | Description |
|---|---|
| Status is the status of the condition. |
| Timestamp is the time a condition occurred. |
| A brief message indicating details about why the component is in this condition. |
| Phase defines the current phase of the data components. |
ContainerHookStatus
(Appears on: PodHookStatus)
ContainerHookStatus defines hook execution status for a containers
| Field | Description |
|---|---|
| ContainerName is container in which hooks are executed. |
| PreHookStatus defines status for pre hooks |
| PostHookStatus defines status for post hooks |
CronSpec
(Appears on: SchedulePolicy)
CronSpec defines the Schedule string and the cronjob reference. The Schedule string will only be visible to the user to be configured, the reference will be set by the controller Deprecated: Instead of using single cron string, schedule policy will use list of cron string
| Field | Description |
|---|---|
|
Crons
(Appears on: PolicySpec)
Crons defines the list of Schedule string and the cronjob references. The list of Schedule string will only be visible to the user to be configured, and the references will be set by the controller
| Field | Description |
|---|---|
|
Custom
(Appears on: RestoreCustom, Snapshot)
Custom defines the snapshot of Custom defined application.
| Field | Description |
|---|---|
| Resources defines the Kubernetes resources found from Custom application. |
| DataSnapshot specifies the Snapshot of the Volumes resources in the Custom defined application. |
| Warnings is the list of warnings captured during backup or restore of an application |
CustomSelector
(Appears on: BackupPlanComponents)
CustomSelector defines custom resource selection using SelectResources which defines include resources & ExcludeResources specify resource exclusion based on Label based & GVK based selection
| Field | Description |
|---|---|
| SelectResources specify resource selection based on |
| ExcludeResources specify resource exclusion based on |
CustomTransform
(Appears on: TransformComponents)
CustomTransform specifies transformation configuration for Custom label-based resources
| Field | Description |
|---|---|
| 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
(Appears on: Custom, Helm, Operator)
DataSnapshot defines Snapshot of a Persistent Volume
| Field | Description |
|---|---|
| BackupType is the type of Volume backup in the sequence of backups. |
| Location is the absolute path of qcow2 image of a volume in the target. |
| PersistentVolumeClaimName is the name of PersistentVolumeClaim which is bound to Volume. |
| PersistentVolumeClaimMetadata is the metadata of PersistentVolumeClaim which is bound to Volume. |
| OperatorResourceVolume will be true for the PVC created by the operator resource. |
| VolumeSnapshot specifies the CSI snapshot of a Persistent Volume. |
| SnapshotSize is the size of captured snapshot of a Persistent Volume. |
Size is the size of complete backup/restore. | |
| Uploaded is to imply whether volume snapshot taken is uploaded to target. |
| 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. |
DayOfWeek (string alias)
string alias)(Appears on: RetentionConfig)
Encryption
(Appears on: BackupPlanSpec, BackupStats, ClusterBackupPlanSpec, ClusterBackupStats, ClusterRestoreSpec, RestoreSpec)
Encryption defines encryption secret to encrypt/decrypt backup data on target
| Field | Description |
|---|---|
| EncryptionSecret is object ref of a secret which contains encryption key for backup encryption |
GroupVersionKind
(Appears on: Owner, Resource, TransformationError)
GroupVersionKind defines the Kubernetes resource type
| Field | Description |
|---|---|
| |
| |
|
Helm
(Appears on: Operator, RestoreHelm, Snapshot)
Helm defines the snapshot of application defined by a Helm.
| Field | Description |
|---|---|
| Release string is the name of release |
| NewRelease string is the new release name which will get used while validation and restore process |
| 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 is the list of warnings captured during backup or restore of an application |
HelmStorageBackend (string alias)
string alias)(Appears on: Helm)
HelmStorageBackend defines the enum for the types of storage backend from where the helm release is backed-up
HelmTransform
(Appears on: TransformComponents)
HelmTransform specifies transformation configuration for Helm
| Field | Description |
|---|---|
| TransformName specifies the name of transformation |
| Release specifies the release name for which the transformation is to be done |
| Set specifies the key-value pair to be set |
HelmVersion (string alias)
string alias)(Appears on: Helm)
HelmVersion defines the version of helm binary used while backup; currently supported version is v3
Hook
Hook is the Schema for the hooks API.
| Field | Description |
|---|---|
| Refer to the Kubernetes API documentation for the fields of the |
|
|
| 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
(Appears on: BackupStatus, RestoreStatus)
HookComponentStatus indicates status of hook execution for backup/restore
| Field | Description |
|---|---|
| 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
(Appears on: BackupComponent, BackupPlanSpec, ComponentConfig, NamespaceSelector, RestoreSpec)
HookConfig defines the sequence of hook actions and their associated pod-container regexes
| Field | Description |
|---|---|
| Mode can be sequential or parallel which defines the way hooks will be executed. If mode is parallel, ignore the hook sequence. |
| 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
(Appears on: HookPriority)
HookConfiguration contain’s configuration for hook implementation.
| Field | Description |
|---|---|
| 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 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 is a boolean, if set to true all the failures will be ignored for both in pre and post hooks Default is false. |
HookExecution
(Appears on: HookSpec)
HookExecution specifies the Hook required to quiesce or unquiesce the application
| Field | Description |
|---|---|
| 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 is a boolean, if set to true all the failures will be ignored both in pre and post hooks Default is false. |
| MaxRetryCount count will be used to retry hook execution within the time range specified by Timeout in |
| TimeoutSeconds is A Maximum allowed time in seconds for each retry count according to value set in |
HookInfo
(Appears on: HookConfig)
HookInfo defines the config for hook action object reference to the matching regexes of pod and containers
| Field | Description |
|---|---|
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 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
(Appears on: HookPriorityStatus)
HookPriority contain hook & their targeted resources
| Field | Description |
|---|---|
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
(Appears on: HookComponentStatus)
HookPriorityStatus defines observed state for hooks priority wise.
| Field | Description |
|---|---|
| Priority defines priority for hooks. backup controller will use |
| Hooks defines list of hooks with priority |
HookSpec
(Appears on: Hook)
HookSpec defines the desired state of Hook.
| Field | Description |
|---|---|
| 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
(Appears on: Hook)
HookStatus defines the observed state of Hook.
HookTarget
(Appears on: HookPriority)
| Field | Description |
|---|---|
| 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 identifies containers in identified pods to execute hooks. |
| PodHookStatus specifies pre/post hook execution status for current backup. |
KeyValue
(Appears on: HelmTransform)
KeyValue specifies key-value pair for helm transformation
| Field | Description |
|---|---|
| Key denotes the key for which value is to be set |
| Value denotes the value to be set |
License
License is the Schema for the licenses API
| Field | Description |
|---|---|
| Refer to the Kubernetes API documentation for the fields of the |
|
|
| Key is the product key to use triliovault application to perform backup/restore. |
| Key is the product key to use triliovault application to perform backup/restore. |
| Key is the product key to use triliovault application to perform backup/restore. |
|
LicenseCondition
(Appears on: LicenseStatus)
LicenseCondition specifies the current condition of a license.
| Field | Description |
|---|---|
| Status is the status of the condition. |
| Timestamp is the time a condition occurred. |
| A brief message indicating details about why the component is in this condition. |
| Phase defines the current phase of the controller. |
LicenseEdition (string alias)
string alias)(Appears on: LicenseProperties)
LicenseEdition specifies the edition of the license.
LicenseProperties
(Appears on: LicenseStatus)
LicenseProperties specifies the properties of a license based on provided license key.
| Field | Description |
|---|---|
| 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 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 is the version of a license. |
| SEN is the unique serial of a license purchased. |
| NumberOfUsers is the total number of users the license valid for. |
| ServerID is the unique serverID of license purchased. |
| LicenseID is the identifier for the license. |
| Capacity is the maximum capacity to use the license in number of kube nodes. |
| Active is the status of the license. |
LicenseSpec
(Appears on: License)
LicenseSpec defines the desired state of License
| Field | Description |
|---|---|
| Key is the product key to use triliovault application to perform backup/restore. |
LicenseState (string alias)
string alias)(Appears on: LicenseCondition, LicenseStatus)
LicenseState specifies the overall status of the license.
LicenseStatus
(Appears on: License)
LicenseStatus defines the observed state of License
| Field | Description |
|---|---|
| Status is the overall status of the license based on provided key. |
| 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 is the total number of nodes kubernetes cluster comprised of where each node capped at 2 vCPUs/pCPUs. |
| 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 is the count of maximum number of nodes available in cluster. |
Mode (string alias)
string alias)(Appears on: HookConfig)
Mode is the enum for 2 modes of quiescing the application components i.e Sequential or Parallel
MonthOfYear (string alias)
string alias)(Appears on: RetentionConfig)
MultiNamespaceCondition
MultiNamespaceCondition specifies the current condition of a clusterNamespace resource.
| Field | Description |
|---|---|
| Status is the status of the condition. |
| Timestamp is the time a condition occurred. |
| A brief message indicating details about why clusterNamespace resource is in this condition. |
NFSCredentials
(Appears on: TargetSpec)
NFSCredentials defines the credentials to use NFS as a target type.
| Field | Description |
|---|---|
| A NFS location in format trilio.net:/data/location/abcde or 192.156.13.1:/user/keeth/data. |
| An additional options passed to mount NFS directory e.g. rw, suid, hard, intr, timeo, retry. |
NamespaceSelector
(Appears on: ClusterBackupPlanSpec)
NamespaceSelector defines namespaces for which backups are to be taken based on NamespaceSelector(labels & match expression) & their configurations
| Field | Description |
|---|---|
| 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 |
ObjectStoreCredentials
(Appears on: TargetSpec)
ObjectStoreCredentials defines the credentials to use Object Store as a target type.
| Field | Description |
|---|---|
| URL to connect the Object Store. |
| AccessKey is to authenticate access to Object Store. Deprecated: after addition of secret object ref |
| 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 is the name of a bucket within Object Store. |
| Region where the Object Store resides. |
| ObjectLockingEnabled specify if target is set to be immutable |
Op (string alias)
string alias)(Appears on: Patch)
Op indicates the Json Patch operations
OperationType (string alias)
string alias)(Appears on: BackupCondition, BackupStatus, ClusterBackupCondition, ClusterRestoreCondition, ClusterRestoreStatus, Conditions, LicenseCondition, TargetCondition)
OperationType specifies the type of operation for Job
Operator
(Appears on: RestoreOperator, Snapshot)
Operator defines the snapshot of application defined by an Operator.
| Field | Description |
|---|---|
| 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 is the list of warnings captured during backup or restore of an application |
OperatorSelector
(Appears on: BackupPlanComponents)
OperatorSelector defines the mapping of operator name and their selectors
| Field | Description |
|---|---|
| OperatorId is any unique ID for a particular operator |
| CustomResources list resources where each resource contains custom resource gvk and metadata |
| HelmRelease is the release name of the helm based operator |
| 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 |
| 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 |
| ExcludeResources specify operator resources to exclude from backup based on |
Owner
(Appears on: HookTarget)
| Field | Description |
|---|---|
| GroupVersionKind specifies GVK uniquely representing particular owner type. |
| Name is name of owner |
Patch
(Appears on: CustomTransform)
| Field | Description |
|---|---|
| Op specifies the operation to perform, can be test/add/remove/replace/copy/move |
| From specifies the source element path. This field is mandatory for copy/move operation |
| Path specifies the destination element path which needs to be transformed |
| Values specifies the value for any operation. This field is mandatory for test/add/replace operation |
PodContainers
(Appears on: DataSnapshot)
PodContainers defines Pod and containers running in that Pod.
| Field | Description |
|---|---|
| PodName is the name of pod which will be the key for the map between pod containers list |
| Containers is the list of containers inside a pod |
PodHookStatus
(Appears on: HookTarget)
PodHookStatus defines observed state for hooks
| Field | Description |
|---|---|
| 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
(Appears on: HookInfo)
PodSelector selects pods for hook execution based on either Labels or Regex pattern. Both Labels & Regex can also specify
| Field | Description |
|---|---|
|
Policy
Policy is the Schema for the policies API
| Field | Description |
|---|---|
| Refer to the Kubernetes API documentation for the fields of the |
|
|
| Type is a field of Policy spec, which defines the policy type containing only 3 values: Retention, Timeout, Cleanup. |
| Default field states if the current type of policy is default across the TV application |
| RetentionConfig field defines the configuration for Retention policies |
| TimeoutConfig field defines the configuration for timeout policies |
| CleanupConfig field defines the configuration for Cleanup policies |
| ScheduleConfig field defines the configuration for Schedule policies |
| Type is a field of Policy spec, which defines the policy type containing only 3 values: Retention, Timeout, Cleanup. |
| Default field states if the current type of policy is default across the TV application |
| RetentionConfig field defines the configuration for Retention policies |
| TimeoutConfig field defines the configuration for timeout policies |
| CleanupConfig field defines the configuration for Cleanup policies |
| ScheduleConfig field defines the configuration for Schedule policies |
| Type is a field of Policy spec, which defines the policy type containing only 3 values: Retention, Timeout, Cleanup. |
| Default field states if the current type of policy is default across the TV application |
| RetentionConfig field defines the configuration for Retention policies |
| TimeoutConfig field defines the configuration for timeout policies |
| CleanupConfig field defines the configuration for Cleanup policies |
| ScheduleConfig field defines the configuration for Schedule policies |
|
PolicySpec
(Appears on: Policy)
PolicySpec defines the desired state of Policy
| Field | Description |
|---|---|
| Type is a field of Policy spec, which defines the policy type containing only 3 values: Retention, Timeout, Cleanup. |
| Default field states if the current type of policy is default across the TV application |
| RetentionConfig field defines the configuration for Retention policies |
| TimeoutConfig field defines the configuration for timeout policies |
| CleanupConfig field defines the configuration for Cleanup policies |
| ScheduleConfig field defines the configuration for Schedule policies |
PolicyStatus
(Appears on: Policy)
PolicyStatus defines the observed state of Policy
PolicyType (string alias)
string alias)(Appears on: PolicySpec)
PolicyType is the Enum for types of policies
PrePostHookStatus
(Appears on: ContainerHookStatus)
PrePostHookStatus defines Pre and Post hook execution status.
| Field | Description |
|---|---|
| Status is the status for pre/post hook execution |
| ExitStatus contains returned exit code and error trace after pre/post hook execution |
| 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 |
Resource
(Appears on: ClusterRestoreStatus, ComponentStatus, Custom, CustomTransform, Helm, Operator, OperatorSelector, ResourceSelector, RestoreConfig, RestoreSpec, RestoreStatus, TransformStatus)
Resource defines the list of names of a Kubernetes resource of a particular GVK.
| Field | Description |
|---|---|
| GroupVersionKind specifies GVK uniquely representing particular resource type. |
| Objects is the list of names of all the objects of the captured GVK |
ResourceSelector
(Appears on: BackupComponent, BackupPlanSpec, ClusterBackupPlanSpec, CustomSelector, NamespaceSelector, OperatorSelector)
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).
| Field | Description |
|---|---|
| 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
Restore is the Schema for the restores API
| Field | Description |
|---|---|
| Refer to the Kubernetes API documentation for the fields of the |
|
|
| Source defines the source referred for performing restore operation |
| 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 specifies whether to skip restore of a resource if already exists in the namespace restored. Deprecated: SkipIfAlreadyExists flag is now moved under |
| PatchIfAlreadyExists specifies whether to patch spec of a already exists resource in the namespace restored. Deprecated: PatchIfAlreadyExists flag is now moved under |
| PatchCRD specifies whether to patch spec of a already exists crd. Deprecated: PatchCRD flag is now moved under |
| OmitMetadata specifies whether to omit metadata like labels, annotations of resources while restoring them. Deprecated: OmitMetadata flag is now moved under |
| 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 |
| 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 |
| |
| |
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 is flag to perform cleanup after restore fails. Defaults to false Deprecated: CleanupOnFailure flag is now moved under |
| ProtectRestoredApp decides if T4K will setup a backupplan to protect the restored application. Deprecated: ProtectRestoredApp flag is now moved under |
| Encryption specify encryption key to decrypt the encrypted data. |
| Source defines the source referred for performing restore operation |
| 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 specifies whether to skip restore of a resource if already exists in the namespace restored. Deprecated: SkipIfAlreadyExists flag is now moved under |
| PatchIfAlreadyExists specifies whether to patch spec of a already exists resource in the namespace restored. Deprecated: PatchIfAlreadyExists flag is now moved under |
| PatchCRD specifies whether to patch spec of a already exists crd. Deprecated: PatchCRD flag is now moved under |
| OmitMetadata specifies whether to omit metadata like labels, annotations of resources while restoring them. Deprecated: OmitMetadata flag is now moved under |
| 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 |
| 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 |
| |
| |
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 is flag to perform cleanup after restore fails. Defaults to false Deprecated: CleanupOnFailure flag is now moved under |
| ProtectRestoredApp decides if T4K will setup a backupplan to protect the restored application. Deprecated: ProtectRestoredApp flag is now moved under |
| Encryption specify encryption key to decrypt the encrypted data. |
| Source defines the source referred for performing restore operation |
| 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 specifies whether to skip restore of a resource if already exists in the namespace restored. Deprecated: SkipIfAlreadyExists flag is now moved under |
| PatchIfAlreadyExists specifies whether to patch spec of a already exists resource in the namespace restored. Deprecated: PatchIfAlreadyExists flag is now moved under |
| PatchCRD specifies whether to patch spec of a already exists crd. Deprecated: PatchCRD flag is now moved under |
| OmitMetadata specifies whether to omit metadata like labels, annotations of resources while restoring them. Deprecated: OmitMetadata flag is now moved under |
| 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 |
| 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 |
| |
| |
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 is flag to perform cleanup after restore fails. Defaults to false Deprecated: CleanupOnFailure flag is now moved under |
| ProtectRestoredApp decides if T4K will setup a backupplan to protect the restored application. Deprecated: ProtectRestoredApp flag is now moved under |
| Encryption specify encryption key to decrypt the encrypted data. |
|
RestoreApplication
(Appears on: RestoreStatus)
RestoreApplication defines the snapshot contents of an Application Backup.
| Field | Description |
|---|---|
| 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. |
RestoreCondition
(Appears on: RestoreStatus)
RestoreCondition specifies the current condition of a restore resource.
| Field | Description |
|---|---|
| Status is the status of the condition. |
| Timestamp is the time a condition occurred. |
| A brief message indicating details about why the component is in this condition. |
| Phase defines the current phase of the controller. |
RestoreConfig
(Appears on: ClusterRestoreSpec, ComponentConfig)
| Field | Description |
|---|---|
| |
| |
|
RestoreCustom
(Appears on: RestoreApplication)
RestoreCustom defines the backed up kubernetes resources.
| Field | Description |
|---|---|
| Snapshot defines the snapshot of custom application to be restored. |
| Status specifies the details of component restore in a namespace |
RestoreFlags
(Appears on: RestoreConfig, RestoreSpec)
| Field | Description |
|---|---|
| SkipIfAlreadyExists specifies whether to skip restore of a resource if already exists in the namespace restored. |
| PatchIfAlreadyExists specifies whether to patch spec of a already exists resource in the namespace restored. |
| PatchCRD specifies whether to patch spec of a already exists crd. |
| OmitMetadata specifies whether to omit metadata like labels, annotations of resources while restoring them. |
| 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 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 flag decides if the restore operation will only restore data components. |
| OnlyMetadata flag decides if the restore operation will only restore metadata components. |
RestoreHelm
(Appears on: RestoreApplication)
RestoreHelm defines the backed up helm application to be restored.
| Field | Description |
|---|---|
| Snapshot defines the snapshot of application to be restored by a Helm. |
| Status specifies the details of component restore in a namespace |
RestoreOperator
(Appears on: RestoreApplication)
RestoreOperator defines the backed up operator application to be restored.
| Field | Description |
|---|---|
| Snapshot defines the snapshot of application to be restored by a Operator. |
| Status specifies the details of component restore in a namespace |
RestorePhase (string alias)
string alias)(Appears on: ComponentStatus, RestoreCondition, RestoreStatus)
nolint:lll // too long line RestorePhase specifies the one of phase of Restore operation
RestoreSource
(Appears on: RestoreSpec)
RestoreSource defines the source from where the restore is to be done
| Field | Description |
|---|---|
| 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 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. |
RestoreSourceType (string alias)
string alias)(Appears on: RestoreSource)
BackupSourceType defines the type of source for restore
RestoreSpec
(Appears on: Restore)
RestoreSpec defines the desired state of Restore
| Field | Description |
|---|---|
| Source defines the source referred for performing restore operation |
| 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 specifies whether to skip restore of a resource if already exists in the namespace restored. Deprecated: SkipIfAlreadyExists flag is now moved under |
| PatchIfAlreadyExists specifies whether to patch spec of a already exists resource in the namespace restored. Deprecated: PatchIfAlreadyExists flag is now moved under |
| PatchCRD specifies whether to patch spec of a already exists crd. Deprecated: PatchCRD flag is now moved under |
| OmitMetadata specifies whether to omit metadata like labels, annotations of resources while restoring them. Deprecated: OmitMetadata flag is now moved under |
| 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 |
| 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 |
| |
| |
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 is flag to perform cleanup after restore fails. Defaults to false Deprecated: CleanupOnFailure flag is now moved under |
| ProtectRestoredApp decides if T4K will setup a backupplan to protect the restored application. Deprecated: ProtectRestoredApp flag is now moved under |
| Encryption specify encryption key to decrypt the encrypted data. |
RestoreStats
(Appears on: RestoreStatus)
RestoreStats defines the stats for a Restore
| Field | Description |
|---|---|
| BackupPlan is the reference to BackupPlan associated with Restore |
Backup is the reference to the Backup associated with Restore |
RestoreStatus
(Appears on: Restore)
RestoreStatus defines the observed state of Restore
| Field | Description |
|---|---|
| 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 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. |
RestoreSummary
(Appears on: BackupPlanStats)
RestoreSummary comprises of restore object references and count of restore with different statuses
| Field | Description |
|---|---|
| LastSuccessfulRestore is the reference to Latest completed Restore of a BackupPlan |
| TotalInProgressRestores is the count of total number of InProgress Restores |
| TotalCompletedRestores is the count of total number of Completed Restores |
| TotalFailedRestores is the count of total number of Failed Restores |
RetentionConfig
(Appears on: PolicySpec)
RetentionConfig is the configuration for the PolicyType: Retention
| Field | Description |
|---|---|
| Latest is the max number of latest backups to be retained |
| Weekly is max number of backups to be retained in a week |
| Monthly is max number of backups to be retained in a month |
| 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 is Date of the month to maintain monthly backup/restore resources |
| MonthOfYear is the month of the backup to retain for yearly backups |
SchedulePolicy
(Appears on: BackupConfig)
SchedulePolicy contains the object references for incremental or full backup type schedule policy
| Field | Description |
|---|---|
| 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 |
Scope (string alias)
string alias)(Appears on: LicenseProperties)
Scope specifies the scope of a resource.
Snapshot
(Appears on: BackupStatus)
Snapshot defines the snapshot contents of an Application Backup.
| Field | Description |
|---|---|
| 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. |
Status (string alias)
string alias)(Appears on: BackupCondition, BackupInfo, BackupPlanInfo, BackupPlanStatus, BackupStatus, ClusterBackupCondition, ClusterBackupPlanCondition, ClusterBackupPlanStatus, ClusterBackupStatus, ClusterRestoreCondition, ClusterRestoreStatus, ComponentInfo, ComponentStatus, Conditions, MultiNamespaceCondition, PrePostHookStatus, RestoreCondition, RestoreStatus, TargetCondition, TargetStatus, TransformStatus, VolumeSnapshot)
Status specifies the status of WorkloadJob operating on
Target
Target is a location where Trilio stores backup.
| Field | Description |
|---|---|
| Refer to the Kubernetes API documentation for the fields of the |
|
|
| 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 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 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 specifies if target browser feature should be enabled for this target or not |
| ThresholdCapacity is the maximum threshold capacity to store backup data. |
|
TargetCondition
(Appears on: TargetStatus)
TargetCondition specifies the current condition of a target resource.
| Field | Description |
|---|---|
| Status is the status of the condition. |
| Timestamp is the time a condition occurred. |
| A brief message indicating details about why the component is in this condition. |
| Phase defines the current phase of the controller. |
TargetInfo
(Appears on: BackupStats, ClusterBackupStats)
TargetInfo contains minimal information about target populated in backup stats
| Field | Description |
|---|---|
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
(Appears on: Target)
TargetSpec defines the specification of a Target.
| Field | Description |
|---|---|
| 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 specifies if target browser feature should be enabled for this target or not |
| ThresholdCapacity is the maximum threshold capacity to store backup data. |
TargetStats
(Appears on: TargetStatus)
TargetStats defines the stats for a Target
| Field | Description |
|---|---|
| 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
(Appears on: Target)
TargetStatus defines the observed state of Target
| Field | Description |
|---|---|
| Condition is the current condition of a target. |
| Status is the final Status of target Available/Unavailable |
| 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 is the period set by default on the target This value will always be in number of days |
TargetType (string alias)
string alias)(Appears on: TargetInfo, TargetSpec)
TargetType is the type of target.
TimeoutConfig
(Appears on: PolicySpec)
TimeoutConfig is the configuration for the PolicyType: Timeout
TransformComponents
(Appears on: RestoreConfig, RestoreSpec)
TransformComponents specifies component wise transformation configuration
| Field | Description |
|---|---|
| HelmTransform specifies the Transformation configuration for Helm charts |
| CustomTransform specifies the Transformation configuration for Custom label-based backup |
TransformStatus
(Appears on: ComponentStatus)
TransformStatus specifies the details of transform operation
| Field | Description |
|---|---|
| TransformName is the name of transformation |
| Status is the status of transform operation |
| TransformedResources Specifies the resources transformed as part of transformation |
| Reason is reason for status in case of failure |
| Errors is the reason for transformation failure. |
TransformationError
(Appears on: TransformStatus)
TransformationError defines the set of errors against names of a Kubernetes resource of a particular GVK.
| Field | Description |
|---|---|
| GroupVersionKind specifies GVK uniquely representing particular resource type. |
| Objects is the map of errors against an object name |
Vendor (string alias)
string alias)(Appears on: TargetInfo, TargetSpec)
Vendor is the third party storage vendor hosting the target
VolumeSnapshot
(Appears on: DataSnapshot)
VolumeSnapshot defines the CSI snapshot of a Persistent Volume.
| Field | Description |
|---|---|
| VolumeSnapshot is a reference to the Persistent Volume Snapshot captured. |
| RetryCount is the number of attempts made to capture Volume Snapshot. |
| Status is the status defining the progress of Volume Snapshot capture. |
| Error is the error occurred while capturing Volume Snapshot if any. |
Generated with gen-crd-api-reference-docs on git commit db567c195.
Last updated