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)
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
BackupComponent
(Appears on: BackupComponentInfo, ClusterBackupPlanSpec)
BackupComponent defines the namespace and their configurations for backup
BackupComponentInfo
BackupCondition
(Appears on: BackupStatus)
BackupCondition specifies the current condition of a backup resource.
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.
BackupInfo
(Appears on: ClusterBackupStatus)
BackupInfo contains the relevant information to uniquely identify a child Backup created from a ClusterBackup
BackupPlan
BackupPlan is the Schema for the BackupPlan API
BackupPlanComponents
(Appears on: BackupPlanSpec)
BackupPlanComponents contains the 3 types of components, helm charts, operators and custom label-based resources
BackupPlanInfo
(Appears on: ClusterBackupPlanStatus)
BackupPlanInfo defines the object reference and status of a 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
BackupPlanStats
(Appears on: BackupPlanStatus)
BackupPlanStats defines the stats for a BackupPlan
BackupPlanStatus
(Appears on: BackupPlan)
BackupPlanStatus defines the observed state of BackupPlan
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
BackupStats
(Appears on: BackupStatus)
BackupStats specifies the stats of a Backup
BackupStatus
(Appears on: Backup)
BackupStatus defines the observed state of Backup
BackupSummary
(Appears on: BackupPlanStats)
BackupSummary comprises of backup object references and count of backups with different statuses
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
ClusterBackup
ClusterBackup is the Schema for the ClusterBackup API
ClusterBackupCondition
(Appears on: ClusterBackupStatus)
ClusterBackupCondition specifies the current condition of a clusterBackup resource.
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.
ClusterBackupPlan
ClusterBackupPlan is the Schema for the ClusterBackupPlan API
ClusterBackupPlanCondition
(Appears on: ClusterBackupPlanStatus)
ClusterBackupPlanCondition specifies the current condition of a cluster backup plan resource.
ClusterBackupPlanSpec
(Appears on: ClusterBackupPlan)
ClusterBackupPlanSpec defines the desired state of ClusterBackupPlan
ClusterBackupPlanStats
(Appears on: ClusterBackupPlanStatus)
ClusterBackupPlanStats defines the stats for a ClusterBackupPlan
ClusterBackupPlanStatus
(Appears on: ClusterBackupPlan)
ClusterBackupPlanStatus defines the observed state of ClusterBackupPlan
ClusterBackupSchedulePolicy
(Appears on: ClusterBackupConfig)
ClusterBackupSchedulePolicy contains the object references for incremental or full backup type schedule policy
ClusterBackupSpec
(Appears on: ClusterBackup)
ClusterBackupSpec defines the desired state of ClusterBackup
ClusterBackupStats
(Appears on: ClusterBackupStatus)
ClusterBackupStats specifies the stats of a ClusterBackup
ClusterBackupStatus
(Appears on: ClusterBackup)
ClusterBackupStatus defines the observed state of ClusterBackup
ClusterBackupSummary
(Appears on: ClusterBackupPlanStats)
ClusterBackupSummary comprises of ClusterBackup object references and count of ClusterBackups with different statuses
ClusterRestore
ClusterRestore defines the desired state of ClusterRestore
ClusterRestoreCondition
(Appears on: ClusterRestoreStatus)
ClusterRestoreSource
(Appears on: ClusterRestoreSpec)
ClusterRestoreSourceType (string
alias)
string
alias)(Appears on: ClusterRestoreSource)
ClusterRestoreSpec
(Appears on: ClusterRestore)
ClusterRestoreSpec defines the source from where the ClusterRestore is to be done
ClusterRestoreStats
(Appears on: ClusterRestoreStatus)
ClusterRestoreStats defines the stats for a RestorCluster
ClusterRestoreStatus
(Appears on: ClusterRestore)
ClusterRestoreStatus defines the observed state of ClusterRestore
ClusterRestoreSummary
(Appears on: ClusterBackupPlanStats)
ClusterRestoreSummary comprises of ClusterRestore object references and count of ClusterRestore with different statuses
ComponentConfig
(Appears on: ClusterRestoreSpec)
ComponentInfo
(Appears on: ClusterRestoreStatus)
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.
Conditions
(Appears on: DataSnapshot)
ContainerHookStatus
(Appears on: PodHookStatus)
ContainerHookStatus defines hook execution status for a containers
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
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
Custom
(Appears on: RestoreCustom, Snapshot)
Custom defines the snapshot of Custom defined 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
CustomTransform
(Appears on: TransformComponents)
CustomTransform specifies transformation configuration for Custom label-based resources
DataSnapshot
(Appears on: Custom, Helm, Operator)
DataSnapshot defines Snapshot of a Persistent Volume
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
GroupVersionKind
(Appears on: Owner, Resource, TransformationError)
GroupVersionKind defines the Kubernetes resource type
Helm
(Appears on: Operator, RestoreHelm, Snapshot)
Helm defines the snapshot of application defined by a Helm.
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
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.
HookComponentStatus
(Appears on: BackupStatus, RestoreStatus)
HookComponentStatus indicates status of hook execution for backup/restore
HookConfig
(Appears on: BackupComponent, BackupPlanSpec, ComponentConfig, NamespaceSelector, RestoreSpec)
HookConfig defines the sequence of hook actions and their associated pod-container regexes
HookConfiguration
(Appears on: HookPriority)
HookConfiguration contain’s configuration for hook implementation.
HookExecution
(Appears on: HookSpec)
HookExecution specifies the Hook required to quiesce or unquiesce the application
HookInfo
(Appears on: HookConfig)
HookInfo defines the config for hook action object reference to the matching regexes of pod and containers
HookPriority
(Appears on: HookPriorityStatus)
HookPriority contain hook & their targeted resources
HookPriorityStatus
(Appears on: HookComponentStatus)
HookPriorityStatus defines observed state for hooks priority wise.
HookSpec
(Appears on: Hook)
HookSpec defines the desired state of Hook.
HookStatus
(Appears on: Hook)
HookStatus defines the observed state of Hook.
HookTarget
(Appears on: HookPriority)
KeyValue
(Appears on: HelmTransform)
KeyValue specifies key-value pair for helm transformation
License
License is the Schema for the licenses API
LicenseCondition
(Appears on: LicenseStatus)
LicenseCondition specifies the current condition of a license.
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.
LicenseSpec
(Appears on: License)
LicenseSpec defines the desired state of License
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
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.
NFSCredentials
(Appears on: TargetSpec)
NFSCredentials defines the credentials to use NFS as a target type.
NamespaceSelector
(Appears on: ClusterBackupPlanSpec)
NamespaceSelector defines namespaces for which backups are to be taken based on NamespaceSelector(labels & match expression) & their configurations
ObjectStoreCredentials
(Appears on: TargetSpec)
ObjectStoreCredentials defines the credentials to use Object Store as a target type.
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.
OperatorSelector
(Appears on: BackupPlanComponents)
OperatorSelector defines the mapping of operator name and their selectors
Owner
(Appears on: HookTarget)
Patch
(Appears on: CustomTransform)
PodContainers
(Appears on: DataSnapshot)
PodContainers defines Pod and containers running in that Pod.
PodHookStatus
(Appears on: HookTarget)
PodHookStatus defines observed state for hooks
PodSelector
(Appears on: HookInfo)
PodSelector selects pods for hook execution based on either Labels or Regex pattern. Both Labels & Regex can also specify
Policy
Policy is the Schema for the policies API
PolicySpec
(Appears on: Policy)
PolicySpec defines the desired state of Policy
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.
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.
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).
Restore
Restore is the Schema for the restores API
RestoreApplication
(Appears on: RestoreStatus)
RestoreApplication defines the snapshot contents of an Application Backup.
RestoreCondition
(Appears on: RestoreStatus)
RestoreCondition specifies the current condition of a restore resource.
RestoreConfig
(Appears on: ClusterRestoreSpec, ComponentConfig)
RestoreCustom
(Appears on: RestoreApplication)
RestoreCustom defines the backed up kubernetes resources.
RestoreFlags
(Appears on: RestoreConfig, RestoreSpec)
RestoreHelm
(Appears on: RestoreApplication)
RestoreHelm defines the backed up helm application to be restored.
RestoreOperator
(Appears on: RestoreApplication)
RestoreOperator defines the backed up operator application to be restored.
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
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
RestoreStats
(Appears on: RestoreStatus)
RestoreStats defines the stats for a Restore
RestoreStatus
(Appears on: Restore)
RestoreStatus defines the observed state of Restore
RestoreSummary
(Appears on: BackupPlanStats)
RestoreSummary comprises of restore object references and count of restore with different statuses
RetentionConfig
(Appears on: PolicySpec)
RetentionConfig is the configuration for the PolicyType: Retention
SchedulePolicy
(Appears on: BackupConfig)
SchedulePolicy contains the object references for incremental or full backup type schedule policy
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.
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.
TargetCondition
(Appears on: TargetStatus)
TargetCondition specifies the current condition of a target resource.
TargetInfo
(Appears on: BackupStats, ClusterBackupStats)
TargetInfo contains minimal information about target populated in backup stats
TargetSpec
(Appears on: Target)
TargetSpec defines the specification of a Target.
TargetStats
(Appears on: TargetStatus)
TargetStats defines the stats for a Target
TargetStatus
(Appears on: Target)
TargetStatus defines the observed state of Target
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
TransformStatus
(Appears on: ComponentStatus)
TransformStatus specifies the details of transform operation
TransformationError
(Appears on: TransformStatus)
TransformationError defines the set of errors against names of a Kubernetes resource of a particular GVK.
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.
Generated with gen-crd-api-reference-docs
on git commit db567c195
.
Last updated