Custom Resource Definitions - Application
This page describes the type and accepted values for all Trilio Custom Resource Definitions.
Last updated
Was this helpful?
1.0.X-1.1.X(Deprecated)
This page describes the type and accepted values for all Trilio Custom Resource Definitions.
Last updated
Was this helpful?
# Custom Resource Definitions - Application
Refer to the Kubernetes API documentation for the fields of the metadata field.
Refers to the spec of the Backup CR
Refers to the status of the Backup CR
(Appears on: )
BackupConfig defines the require configuration for taking the backup such as target and retention policy
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 includes the 2 type of cron schedule specs: incremental and full
BackupPlan is the Schema for the applications API
Refer to the Kubernetes API documentation for the fields of the metadata field.
Refers to the spec of the BackupPlan CR
Refers to the status of the BackupPlan CR
BackupPlanComponents contains the 3 types of components, helm charts, operators and custom label-based resources
helmReleases
[]string
HelmReleases is the list of release names
Operators is the list of operator names and their selectors
Custom is the combination of label selectors including match labels and match expressions
BackupPlanSpec defines the desired state of BackupPlan
backupNamespace
string
Namespace is the namespace from where the components of backupPlan to be selected
BackupConfig is the type containing the object references for all the configurations needed for backup operation
BackupPlanComponents includes all the components which defines this BackupPlan i.e Helm charts, operators and label based resources
Hooks section defines the config for hook action object reference to the matching regexes of pod and containers
QuiescingMode is the quiescing mode which can be sequential or parallel. If mode is parallel, ignore the sequence config
sequence
[]Kubernetes meta/v1.LabelSelector
QuiescingSequence is the list of label selectors of 2 types match labels and match expressions
BackupPlanStatus defines the observed state of BackupPlan
Status defines the status of the application resource as available when no operation is running and unavailable when a backup or restore operation is in progress
string alias)BackupScheduleType specifies the type of schedule which triggered the backup
BackupSpec defines the desired state of Backup
Type is the type of backup in the sequence of backups of an Application.
ScheduleType specifies the type of schedule which triggered the backup.
BackupPlan is a reference to the BackupPlan to be backed up.
BackupStatus defines the observed state of Backup
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 is the current phase of the backup operation.
phaseStatus
Status
PhaseStatus is the status of phase backup operation going through.
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.
Optional
string alias)BackupType defines the type backup instance of an BackupPlan
CleanupConfig is the configuration for the PolicyType: Cleanup
backupDays
int
BackupDays is the age of backups to be cleaned
ComponentStatus defines the details of restore of application component.
ExistingResource specifies the resources already existing in cluster defined in application.
SkippedResources specifies the resources skipped while restoring.
FailedResources specifies the resources for which the restore operation failed
NewResourcesAdded specifies the resources added(duplicated and modified) during restore.
Phase is the current phase of the application component while restore.
PhaseStatus is the status of phase restore operation going through.
reason
string
A brief message indicating details about why the application component is in this state.
Condition specifies the current condition of a resource.
Type is the type of condition data component is in.
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.
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
schedule
string
Defines the backup schedule
cronJobRef
Kubernetes core/v1.ObjectReference
CronJob Reference
Custom defines the snapshot of Custom defined application.
Resources defines the Kubernetes resources found from Custom application.
DataSnapshot specifies the Snapshot of the Volumes resources in the Custom defined application.
warnings
[]string
Warnings is the list of warnings captured during backup or restore of an application
DataSnapshot defines Snapshot of a Persistent Volume
BackupType is the type of Volume backup in the sequence of backups.
location
string
Location is the absolute path of qcow2 image of a volume in the target.
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.
VolumeSnapshot specifies the CSI snapshot of a Persistent Volume.
snapshotSize
k8s.io/apimachinery/pkg/api/resource.Quantity
SnapshotSize is the size of captured snapshot of a Persistent Volume.
size
k8s.io/apimachinery/pkg/api/resource.Quantity
Size is the size of complete backup/restore.
uploaded
bool
Uploaded is to imply whether volume snapshot taken is uploaded to target.
Condition is the current condition of a data component while backup/restore.
PodContainersMap is the set of Pod-Containers which share Persistent Volume.
string alias)GroupVersionKind defines the Kubernetes resource type
group
string
API Resource Group
version
string
API Resource version
kind
string
API Resource Kind
Helm defines the snapshot of application defined by a Helm.
release
string
Release string is the name of release
newRelease
string
NewRelease string is the new release name which will get used while validation and restore process
revision
int32
Revision defines the version of deployed release backed up
Resource is the captured GVK (secret or configmap) and corresponding object names slice
StorageBackend is the enum which can be either configmaps and secrets
Version represents the Helm binary version used at the time of snapshot
DataSnapshot specifies the Snapshot of the Volumes defined in the helm chart resources.
warnings
[]string
Warnings is the list of warnings captured during backup or restore of an application
string alias)HelmStorageBackend defines the enum for the types of storage backend from where the helm release is backed-up
string alias)HelmVersion defines the 2 versions of helm binaries used while backup
Hook is the Schema for the hooks API.
Refer to the Kubernetes API documentation for the fields of the metadata field.
Spec for Hook
Status for Hook
HookConfig defines the sequence of hook actions and their associated pod-container regexes
Hook is the object reference of the Hook resource which will be run while quiescing
MatchPatterns is the list/sequence of the pod-container regex where the hook needs to be executed
HookExecution specifies the Hook required to quiesce or unquiesce the application
command
[]string
A Command to be executed as a part of Hook.
hookTimeout
int16
A Maximum allowed time to execute Hook.
HookSpec defines the desired state of Hook.
PreHook is the Hook executed to quiesce the application before backup operation
PostHook is the Hook executed to unquiesce the application after backup operation
HookStatus defines the observed state of Hook.
License is the Schema for the licenses API
Refer to the Kubernetes API documentation for the fields of the metadata field.
Spec of License CR
Status of License CR
LicenseCondition specifies the current condition of a license.
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.
string alias)LicenseEdition specifies the edition of the license.
LicenseProperties specifies the properties of a license based on provided license key.
company
string
Company is the name of a company purchased license for.
Edition is the type of license purchased to use triliovault application.
creationTimestamp
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 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
uint16
Capacity is the maximum capacity to use the license in number of kube nodes.
active
bool
Active is the status of the license.
LicenseSpec defines the desired state of License
key
string
Key is the product key to use triliovault application to perform backup/restore.
string alias)LicenseState specifies the overall status of the license.
LicenseStatus defines the observed state of License
Status is the overall status of the license based on provided key.
message
string
A brief message indicating details about why the license in this state.
Properties is the details about the license based on provided license key.
Condition is the current condition of a license.
currentNodeCount
uint16
CurrentNodeCount is the total number of nodes kubernetes cluster comprised of where each node capped at 2 vCPUs/pCPUs.
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.
MatchPattern is the structure defining the pod-container regexes used for hook execution
podRegexPattern
string
PodRegexPattern is the regex pattern to be matched for the pod where hooks will be executed
containerRegexPattern
string
ContainerRegexPattern is the regex pattern to be matched for the containers where hooks will be executed
string alias)NFSCredentials defines the credentials to use NFS as a target type.
nfsExport
string
A NFS location in format trilio.net:/data/location/abcde or 192.156.13.1:/user/keeth/data.
nfsOptions
string
An additional options passed to mount NFS directory e.g. rw, suid, hard, intr, timeo, retry.
ObjectStoreCredentials defines the credentials to use Object Store as a target type.
url
string
Url to connect the Object Store.
accessKey
string
Access Key is to authenticate access to Object Store.
secretKey
string
Secret Key is to authenticate access to Object Store.
bucketName
string
Name of a bucket within Object Store.
region
string
Region where the Object Store resides.
string alias)OperationType specifies the type of operation for Job
Operator defines the snapshot of application defined by an Operator.
operatorId
string
OperatorId is unique ID for a particular operator
CustomResources is the list of all custom resource’s GVK and names list
Helm represents the snapshot of the helm chart for helm based operator
OperatorResources defines the a kubernetes resources found from Operator resources.
DataSnapshot specifies the Snapshot of the Volumes defined in the operator resources.
warnings
[]string
Warnings is the list of warnings captured during backup or restore of an application
OperatorSelector defines the mapping of operator name and their selectors
operatorId
string
OperatorId is any unique ID for a particular operator
CustomResources list resources where each resource contains custom resource gvk and metadata
helmRelease
string
HelmRelease is the release name of the helm based operator
olmSubscription
string
OLMSubscription is the release name of the helm based operator
operatorResourceSelector
[]Kubernetes meta/v1.LabelSelector
OperatorResourceSelector is the selector for operator resources
applicationResourceSelector
[]Kubernetes meta/v1.LabelSelector
ApplicationResourceSelector is the selector for instances deployed by the operator resources
PodContainers defines Pod and containers running in that Pod.
podName
string
PodName is the name of pod which will be the key for the map between pod containers list
containers
[]string
Containers is the list of containers inside a pod
Policy is the Schema for the policies API
Refer to the Kubernetes API documentation for the fields of the metadata field.
Spec of Policy CR
Status of Policy CR
PolicySpec defines the desired state of Policy
Type is a field of Policy spec, which defines the policy type containing only 3 values: Retention, Timeout, Cleanup.
default
bool
Default field states if the current type of policy is default across the TV application
RetentionConfig field defines the configuration for Retention policies
TimeoutConfig field defines the configuration for timeout policies
CleanupConfig field defines the configuration for Cleanup policies
Policy Status defines the observed state of Policy
string alias)PolicyType is the Enum for types of policies
string alias)QuiescingMode is the enum for 2 modes of quiescing the application components i.e Sequential or Parallel
Resource defines the list of names of a Kubernetes resource of a particular GVK.
GroupVersionKind specifies GVK uniquely representing particular resource type.
objects
[]string
Objects is the list of names of all the objects of the captured GVK
Restore is the Schema for the restores API Backup respresents the capture of Kubernetes Application defined by user at a point in time
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
Spec of Restore CR
Status of Restore CR
RestoreApplication defines the snapshot contents of an Application Backup.
HelmCharts specifies the backed up helm resources restored as Helm Charts.
Operators specifies the backed up operator resources restored as Operators.
Custom specifies the backup up kubernetes resources.
RestoreCustom defines the backed up kubernetes resources.
Snapshot defines the snapshot of custom application to be restored.
Status specifies the details of component restore in a namespace
RestoreHelm defines the backed up helm application to be restored.
Snapshot defines the snapshot of application to be restored by a Helm.
Status specifies the details of component restore in a namespace
RestoreOperator defines the backed up operator application to be restored.
Snapshot defines the snapshot of application to be restored by a Operator.
Status specifies the details of component restore in a namespace
string alias)RestorePhase specifies the one of phase of Restore operation
Type is the type of source for restore
Backup is a reference to the Backup instance restored if type is Backup.
Target is a reference to the Target instance where from restore is performed if type is Location.
location
string
Location is an absolute path to remote target from where restore is performed if type is Location.
string alias)BackupSourceType defines the type of source for restore
RestoreSpec defines the desired state of Restore
BackupPlan is a reference to the BackupPlan whose backup is restored.
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
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.
omitMetadata
bool
OmitMetadata specifies whether to omit metadata like labels, annotations of resources while restoring them.
Env is the List of environment variables to set in the container. Cannot be updated.
RestoreStatus defines the observed state of Restore
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 is the current phase of the restore operation.
PhaseStatus is the status of phase restore operation going through.
Status is the status of the restore operation.
size
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 defines the information about the different applications restored back to cluster.
RetentionConfig is the configuration for the PolicyType: Retention
daily
int
Daily is max number of backups to be retained in a day
weekly
int
Weekly is max number of backups to be retained in a week
monthly
int
Monthly is max number of backups to be retained in a month
yearly
int
Yearly is max number of backups to be retained in a year
DayOfWeek is Day of the week to maintain weekly backup/restore resources
date_of_month
int
DateOfMonth is Date of the month to maintain monthly backup/restore resources
MonthOfYear is the month of the backup to retain for yearly backups
SchedulePolicy defines the cronjob specs for incremental or full backup types
IncrementalCron is the cronspec schedule for incremental backups
FullBackupCron is the cronspec schedule for full backups
string alias)Scope specifies the scope of a resource.
Snapshot defines the snapshot contents of an Application Backup.
HelmCharts specifies the snapshot of application defined by Helm Charts.
Operators specifies the snapshot of application defined by Operators.
Custom specifies the snapshot of Custom defined applications.
string alias)Status specifies the status of WorkloadJob operating on
Target is a location where Trilio stores backup.
Refer to the Kubernetes API documentation for the fields of the metadata field.
TargetSpec defines the specification of a Target.
Type is the type of target for backup storage.
Vendor is the third party storage vendor hosting the target
NfsCredentials specifies the credentials for TargetType NFS
ObjectStoreCredentials specifies the credentials for TargetType ObjectStore
TargetStatus defines the observed state of Target
Condition is the current condition of a target.
Status is the final Status of target Available/Unavailable
string alias)TargetType is the type of target.
TimeoutConfig is the configuration for the PolicyType: Timeout
string alias)Vendor is the third party storage vendor hosting the target
VolumeSnapshot defines the CSI snapshot of a Persistent Volume.
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 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 c3c084d1.
metadata
spec
status
schedulePolicy
metadata
spec
status
(Appears on: )
operators
custom
(Appears on: )
backupConfig
backupPlanComponents
hooks
quiescingMode
(Appears on: )
status
(Appears on: )
(Appears on: )
type
scheduleType
backupPlan
(Appears on: )
phase
status
snapshot
(Appears on: , )
(Appears on: )
(Appears on: , , )
existingResource
skippedResources
failedResources
newResourcesAdded
phase
phaseStatus
(Appears on: , )
type
status
(Appears on: )
(Appears on: , )
resources
dataSnapshots
(Appears on: , , )
backupType
volumeSnapshot
condition
podContainersMap
(Appears on: )
(Appears on: )
(Appears on: , , )
resource
storageBackend
version
dataSnapshots
(Appears on: )
(Appears on: )
metadata
spec
status
(Appears on: )
hook
matchPatterns
(Appears on: )
(Appears on: )
pre
post
(Appears on: )
metadata
spec
status
(Appears on: )
status
(Appears on: )
(Appears on: )
edition
scope
(Appears on: )
(Appears on: , )
(Appears on: )
status
properties
condition
(Appears on: )
(Appears on: )
(Appears on: )
(Appears on: )
(Appears on: , )
(Appears on: , )
customResources
helm
operatorResources
dataSnapshots
(Appears on: )
customResources
(Appears on: )
metadata
spec
status
(Appears on: )
type
retentionConfig
timeoutConfig
cleanupConfig
(Appears on: )
(Appears on: )
(Appears on: )
(Appears on: , , , , )
groupVersionKind
spec
status
(Appears on: )
helmCharts
operators
custom
(Appears on: )
snapshot
status
(Appears on: )
snapshot
status
(Appears on: )
snapshot
status
(Appears on: , )
(Appears on: )
type
backup
target
(Appears on: )
(Appears on: )
backupPlan
source
env
(Appears on: )
phase
phaseStatus
status
restoreApplication
(Appears on: )
day_of_week
month_of_year
(Appears on: )
incrementalCron
fullBackupCron
(Appears on: )
(Appears on: )
helmCharts
operators
custom
(Appears on: , , , , , , )
metadata
spec
status
(Appears on: )
type
vendor
nfsCredentials
objectStoreCredentials
(Appears on: )
condition
status
(Appears on: )
(Appears on: )
(Appears on: )
(Appears on: )
status