3.0.X
Search…
⌃K

Custom Resource Definition - Application

API reference for TrilioVault Application
Packages:

triliovault.trilio.io/v1

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

ActionFlags

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

ApplicationType (string alias)

ApplicationType specifies type of a Backup of an application

Backup

Backup represents the capture of Kubernetes BackupPlan defined by user at a point in time
Field
Description
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec BackupSpec
type BackupType
Type is the type of backup in the sequence of backups of an Application.
BackupPlan is a reference to the BackupPlan to be backed up.
type BackupType
Type is the type of backup in the sequence of backups of an Application.
BackupPlan is a reference to the BackupPlan to be backed up.
status BackupStatus

BackupComponent

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

BackupComponentInfo

Field
Description
BackupComponent BackupComponent
Name string

BackupCondition

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

BackupConfig

(Appears on: BackupPlanSpec)
BackupConfig defines the required configuration for taking the backup such as target and retention policy. NOTE: ClusterBackupConfig field in clusterbackupplan_types.go is similar to this structure. Changes made here might be required to be reflected there as well.
Field
Description
Target is the object reference for the backup target resources
RetentionPolicy is the object reference for the policy of type retention defined
schedulePolicy SchedulePolicy
SchedulePolicy includes the object references of 2 type of cron schedule policy: incremental and full
maxIncrBackupsPerFullBackup byte
MaxIncrBackupsPerFullBackup is the number of incremental backups after which full backup will ge triggered. This is relevant only in case of immutable backups

BackupInfo

(Appears on: ClusterBackupStatus)
BackupInfo contains the relevant information to uniquely identify a child Backup created from a ClusterBackup
Field
Description
Backup ObjectReference of child Backup
status Status
Status status of child Backup
percentageCompletion byte
PercentageCompletion is the amount of backup operation completed.
location string
Location is the Backup’s location on the target

BackupPlan

BackupPlan is the Schema for the BackupPlan API
Field
Description
Refer to the Kubernetes API documentation for the fields of the metadata field.
backupNamespace string
Namespace is the namespace from where the components of backupPlan to be selected Deprecated: After removal of cluster scope CRD support, Backup namespace will be same as BackupPlan namespace.
backupConfig BackupConfig
BackupConfig is the type containing the object references for all the configurations needed for backup operation
backupPlanComponents BackupPlanComponents
BackupPlanComponents includes all the components which defines this BackupPlan i.e Helm charts, operators and label based resources
hookConfig HookConfig
hookConfig defines backup pre/post hooks and their configurations.
includeResources ResourceSelector
IncludeResources specify resources to include for namespace scope backup based on LabelSelector & GVKSelector. This acts similar like SelectResources used in custom or operators.
excludeResources ResourceSelector
ExcludeResources specify resources to exclude for namespace scope backup based on LabelSelector & GVKSelector
encryption Encryption
Encryption specify how to encrypt backups on target for this backupPlan
securityScanConfig SecurityScanConfigInfo
SecurityScanConfig defines the Security Scan config to be used for Backup scanning
continuousRestoreConfig ContinuousRestoreConfigInfo
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 BackupPlanFlags
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 BackupConfig
BackupConfig is the type containing the object references for all the configurations needed for backup operation
backupPlanComponents BackupPlanComponents
BackupPlanComponents includes all the components which defines this BackupPlan i.e Helm charts, operators and label based resources
hookConfig HookConfig
hookConfig defines backup pre/post hooks and their configurations.
includeResources ResourceSelector
IncludeResources specify resources to include for namespace scope backup based on LabelSelector & GVKSelector. This acts similar like SelectResources used in custom or operators.
excludeResources ResourceSelector
ExcludeResources specify resources to exclude for namespace scope backup based on LabelSelector & GVKSelector
encryption Encryption
Encryption specify how to encrypt backups on target for this backupPlan
securityScanConfig SecurityScanConfigInfo
SecurityScanConfig defines the Security Scan config to be used for Backup scanning
continuousRestoreConfig ContinuousRestoreConfigInfo
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 BackupPlanFlags
BackupPlanFlags specifies all the flags specified at the backup plan level.

BackupPlanComponents

(Appears on: BackupPlanSpec)
BackupPlanComponents contains the 3 types of components, helm charts, operators and custom label-based resources
Field
Description
helmReleases []string
HelmReleases is the list of release names
operators []OperatorSelector
Operators is the list of operator names and their selectors
Deprecated: Custom is the combination of label selectors including match labels and match expressions
customSelector CustomSelector
CustomSelector specify resource selection for custom resources, This is the combination of LabelSelectorincluding match labels and match expressions and GVKSelector which could be GroupVersionKind & Objects

BackupPlanCondition

(Appears on: BackupPlanStatus)
BackupPlanCondition specifies the current condition of a backupPlan resource.
Field
Description
status Status
Status is the status of the condition.
Timestamp is the time a condition occurred.
reason string
A brief message indicating details about why the component is in this condition.
phase OperationType
Phase defines the current phase of the controller.

BackupPlanFlags

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

BackupPlanInfo

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

BackupPlanSelector (string alias)

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

BackupPlanSpec

(Appears on: BackupPlan)
BackupPlanSpec defines the desired state of BackupPlan
Field
Description
backupNamespace string
Namespace is the namespace from where the components of backupPlan to be selected Deprecated: After removal of cluster scope CRD support, Backup namespace will be same as BackupPlan namespace.
backupConfig BackupConfig
BackupConfig is the type containing the object references for all the configurations needed for backup operation
backupPlanComponents BackupPlanComponents
BackupPlanComponents includes all the components which defines this BackupPlan i.e Helm charts, operators and label based resources
hookConfig HookConfig
hookConfig defines backup pre/post hooks and their configurations.
includeResources ResourceSelector
IncludeResources specify resources to include for namespace scope backup based onLabelSelector & GVKSelector. This acts similar like SelectResources used in custom or operators.
excludeResources ResourceSelector
ExcludeResources specify resources to exclude for namespace scope backup based on LabelSelector & GVKSelector
encryption Encryption
Encryption specify how to encrypt backups on target for this backupPlan
securityScanConfig SecurityScanConfigInfo
SecurityScanConfig defines the Security Scan config to be used for Backup scanning
continuousRestoreConfig ContinuousRestoreConfigInfo
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 BackupPlanFlags
BackupPlanFlags specifies all the flags specified at the backup plan level.

BackupPlanStats

(Appears on: BackupPlanStatus)
BackupPlanStats defines the stats for a BackupPlan
Field
Description
backupSummary BackupSummary
restoreSummary RestoreSummary
immutable bool
Immutable specify whether a backup data is going to be immutable.

BackupPlanStatus

(Appears on: BackupPlan)
BackupPlanStatus defines the observed state of BackupPlan
Field
Description
Condition is the current condition of a backupPlan.
status Status
Status defines the status oif the application resource as available when no operation is running and unavailable when a backup or restore operation is in progress
Scope indicates scope of component in BackupPlan i.e. App or Namespace.
applicationType ApplicationType
ApplicationType is the type of BackupPlan defining backup
Deprecated: IncrementalCron will be used as an list of references of Crons
Deprecated: FullBackupCron will be used as an list of references of Crons
SecurityScanStatus contains the information of each Security instanceID defined, and it’s Security Scan status
ContinuousRestoreStatus contains the information of each ContinuousRestore instanceID defined, and it’s ContinuousRestore service status

BackupScanInfo

(Appears on: ScanInstance)
Field
Description
MetadataScannerStatus is the result of Metadata Scanning It is the mapping of scanner name and its corresponding report
DataScannerStatus is the result of Data Scanning It is the mapping of scanner name and its corresponding report
ImageScannerStatus is the result of Image Scanning It is the mapping of scanner name and its corresponding report

BackupScheduleType (string alias)

BackupScheduleType specifies the type of schedule which triggered the backup

BackupSpec

(Appears on: Backup)
BackupSpec defines the desired state of Backup
Field
Description
type BackupType
Type is the type of backup in the sequence of backups of an Application.
BackupPlan is a reference to the BackupPlan to be backed up.

BackupStats

(Appears on: BackupStatus)
BackupStats specifies the stats of a Backup
Field
Description
Target is the reference to a Target backuped up Deprecated: Target information moved to TargetInfo field.
targetInfo TargetInfo
TargetInfo is the information to a Target backed up
latestInProgressRestore Kubernetes core/v1.ObjectReference
LatestInProgressRestore is the reference to the latest InProgress Restore of a Backup
latestCompletedRestore Kubernetes core/v1.ObjectReference
LatestCompletedRestore is the reference to the latest Completed Restore of a Backup
hookExists bool
HookExists is a bool value that states if a backup has hooks in backup plan
encryption Encryption
Encryption specifies encryption details of a backup
immutable bool
Immutable specify whether a backup data is immutable

BackupStatus

(Appears on: Backup)
BackupStatus defines the observed state of Backup
Field
Description
backupScope ComponentScope
BackupScope indicates scope of component in backup i.e. App or Namespace.
applicationType ApplicationType
ApplicationType is the type of Application backed up in the App Scoped backup.
type BackupType
Type indicates the backup type in backup i.e. Full, Incremental or Mixed.
location string
Location is the absolute path of the target where backup resides.
startTimestamp Kubernetes meta/v1.Time
StartTimestamp is the time a backup was started.
completionTimestamp Kubernetes meta/v1.Time
CompletionTimestamp is the time a backup was finished.
phase OperationType
Phase is the current phase of the backup operation.
phaseStatus Status
PhaseStatus is the status of phase backup operation going through.
status Status
Status is the status of the backup operation.
Size is the aggregate size of the data backuped up.
percentageCompletion byte
PercentageCompletion is the amount of backup operation completed.
expirationTimestamp Kubernetes meta/v1.Time
ExpirationTimeStamp is the time a backup will not be available after retention.
snapshot Snapshot
Todo: Do we need this option as optional one? Todo: This is optional because, we are allowing the custom backup as empty Snapshot specifies the contents of captured backup.
condition []BackupCondition
Condition is the current condition of hooks while backup.
hookStatus HookComponentStatus
HookStatus specifies pre/post hook execution status for current backup.
stats BackupStats
SecurityScanStatus contains the information of Security Scan performed for Backup on each Security instanceID defined.
ConsistentSetStatus contains the mapping of instanceID and the ContinuousRestore performed for Backup on that ContinuousRestore site instance.
Duration is the amount of time the backup process took to finish.
encryptionEnabled bool
EncryptionEnabled flag shows that encryption is enabled for backup

BackupSummary

(Appears on: BackupPlanStats)
BackupSummary comprises of backup object references and count of backups with different statuses
Field
Description
InProgressBackup is the reference to an InProgress backup of a BackupPlan
lastSuccessfulBackup Kubernetes core/v1.ObjectReference
LastSuccessfulBackup is the reference to Latest available Backup of a BackupPlan
LatestBackup is the reference to Latest Backup in any state, of a BackupPlan
totalAvailableBackups uint32
TotalAvailableBackups is the count of total number of Available Backups
totalFailedBackups uint32
TotalFailedBackups is the count of total number of InProgress Backups
totalQueuedBackups uint32
TotalQueuedBackups is the count of total number of Queued Backups
pvcExistsForBackup bool
PVCExistsForBackup is a bool value that states if the latest backup of a backup plan has PVCs in its data component

BackupType (string alias)

BackupType defines the type backup instance of an BackupPlan

CleanupConfig

(Appears on: PolicySpec)
CleanupConfig is the configuration for the PolicyType: Cleanup
Field
Description
backupDays int
BackupDays is the age of backups to be cleaned

ClusterBackup

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

ClusterBackupCondition

(Appears on: ClusterBackupStatus)
ClusterBackupCondition specifies the current condition of a clusterBackup resource.
Field
Description
phase OperationType
Phase defines the current phase of the controller.
status Status
Status is the status of the condition.
Timestamp is the time a condition occurred.
reason string
A brief message indicating details about why clusterBackup is in this condition.

ClusterBackupConfig

(Appears on: ClusterBackupPlanSpec)
ClusterBackupConfig defines the require configuration for taking the backup such as target and retention policy. NOTE: BackupConfig field in backupplan_types.go is similar to this structure. Changes made here might be required to be reflected there as well.
Field
Description
Target is the object reference for the backup target resources
RetentionPolicy is the object reference for the policy of type retention defined
schedulePolicy ClusterBackupSchedulePolicy
SchedulePolicy includes the object references of 2 type of cron schedule policy: incremental and full
maxIncrBackupsPerFullBackup byte
MaxIncrBackupsPerFullBackup is the number of incremental backups after which full backup will ge triggered. This is relevant only in case of immutable backups

ClusterBackupPlan

ClusterBackupPlan is the Schema for the ClusterBackupPlan API
Field
Description
Refer to the Kubernetes API documentation for the fields of the metadata field.
backupComponents []BackupComponent
BackupComponents defines all the BackupComponents for which backups are to be taken. It includes namespaces and their configurations
namespaceSelector []NamespaceSelector
NamespaceSelector defines namespaces for which backups are to be taken based on NamespaceSelector(labels & match expression) & their configurations
backupConfig ClusterBackupConfig
BackupConfig is the type containing the object references for all the configurations needed for backup operation
includeResources ResourceSelector
IncludeResources specifies the resources to be explicitly included during backup
excludeResources ResourceSelector
ExcludedResources specifies the resources to be excluded from the backup
encryption Encryption
Encryption specify how to encrypt backups on target for this backupPlan
securityScanConfig SecurityScanConfigInfo
SecurityScanConfig defines the Security Scan config to be used for ClusterBackup scanning
continuousRestoreConfig ContinuousRestoreConfigInfo
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.
clusterBackupPlanFlags BackupPlanFlags
BackupPlanFlags specifies all the flags specified at the cluster backup plan level.
backupComponents []BackupComponent
BackupComponents defines all the BackupComponents for which backups are to be taken. It includes namespaces and their configurations
namespaceSelector []NamespaceSelector
NamespaceSelector defines namespaces for which backups are to be taken based on NamespaceSelector(labels & match expression) & their configurations
backupConfig ClusterBackupConfig
BackupConfig is the type containing the object references for all the configurations needed for backup operation
includeResources ResourceSelector
IncludeResources specifies the resources to be explicitly included during backup
excludeResources ResourceSelector
ExcludedResources specifies the resources to be excluded from the backup
encryption Encryption
Encryption specify how to encrypt backups on target for this backupPlan
securityScanConfig SecurityScanConfigInfo
SecurityScanConfig defines the Security Scan config to be used for ClusterBackup scanning
continuousRestoreConfig ContinuousRestoreConfigInfo
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.
clusterBackupPlanFlags BackupPlanFlags
BackupPlanFlags specifies all the flags specified at the cluster backup plan level.

ClusterBackupPlanCondition

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

ClusterBackupPlanSpec

(Appears on: ClusterBackupPlan)
ClusterBackupPlanSpec defines the desired state of ClusterBackupPlan
Field
Description
backupComponents []BackupComponent
BackupComponents defines all the BackupComponents for which backups are to be taken. It includes namespaces and their configurations
namespaceSelector []NamespaceSelector
NamespaceSelector defines namespaces for which backups are to be taken based on NamespaceSelector(labels & match expression) & their configurations
backupConfig ClusterBackupConfig
BackupConfig is the type containing the object references for all the configurations needed for backup operation
includeResources ResourceSelector
IncludeResources specifies the resources to be explicitly included during backup
excludeResources ResourceSelector
ExcludedResources specifies the resources to be excluded from the backup
encryption Encryption
Encryption specify how to encrypt backups on target for this backupPlan
securityScanConfig SecurityScanConfigInfo
SecurityScanConfig defines the Security Scan config to be used for ClusterBackup scanning
continuousRestoreConfig ContinuousRestoreConfigInfo
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.
clusterBackupPlanFlags BackupPlanFlags
BackupPlanFlags specifies all the flags specified at the cluster backup plan level.

ClusterBackupPlanStats

ClusterBackupPlanStats defines the stats for a ClusterBackupPlan
Field
Description
clusterBackupSummary ClusterBackupSummary
clusterRestoreSummary ClusterRestoreSummary
immutable bool
Immutable specify whether a backup data is going to be immutable

ClusterBackupPlanStatus

(Appears on: ClusterBackupPlan)
ClusterBackupPlanStatus defines the observed state of ClusterBackupPlan
Field
Description
status Status
Status defines the current state of the ClusterBackupPlan resource. Availablestate ClusterBackupPlan only can be used for ClusterBackup
BackupPlans is the map of backupPlan name and its object ref managed by cluster backup plan
Condition is the current condition of a cluster backup plan.
SecurityScanStatus contains the information of each Security instanceID defined, and it’s Security Scan status
ContinuousRestoreStatus contains the information of each ContinuousRestore instanceID defined, and it’s ContinuousRestore service status

ClusterBackupSchedulePolicy

(Appears on: ClusterBackupConfig)
ClusterBackupSchedulePolicy contains the object references for incremental or full backup type schedule policy
Field
Description
incrementalBackupPolicy Kubernetes core/v1.ObjectReference
IncrementalBackupPolicy is the object reference for the policy of type schedule defined
fullBackupPolicy