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